PACIO Advance Directive Interoperability Implementation Guide - Local Development build (v0.0.1). See the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-PersonalInterventionRequestPreference |
Version: | 0.0.1 |
Name: | PADIPersonalInterventionRequestPreference |
Title: | ADI Personal Intervention Request Preference |
Status: | Active as of 2021-06-04T15:56:50-07:00 |
Definition: | This profile is used to represent a personal preference for a type of medical intervention (treatment) request under certain conditions. |
Publisher: | HL7 Patient Empowerment Working Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-PersonalInterventionRequestPreference
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
status | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Required Pattern: active | |
intent | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: directive | |
doNotPerform | S | 0..1 | boolean | True if service/procedure should not be performed |
code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: Intervention Preferences (extensible) |
orderDetail | S | 0..* | CodeableConcept | Additional order information |
subject | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | |
asNeeded[x] | S | 0..1 | boolean, CodeableConcept | Preconditions for service |
requester | 1..1 | Reference(US Core Patient Profile) | Who/what is requesting service | |
reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | A request for a service to be performed |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces |
requisition | Σ | 0..1 | Identifier | Composite Request ID |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. Required Pattern: active |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Required Pattern: directive |
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
doNotPerform | ?!SΣ | 0..1 | boolean | True if service/procedure should not be performed |
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Intervention Preferences (extensible) |
orderDetail | SΣI | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
quantity[x] | Σ | 0..1 | Service amount | |
quantityQuantity | Quantity | |||
quantityRatio | Ratio | |||
quantityRange | Range | |||
subject | Σ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created |
occurrence[x] | Σ | 0..1 | When service should occur | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
asNeeded[x] | SΣ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | Σ | 0..1 | dateTime | Date request signed |
requester | Σ | 1..1 | Reference(US Core Patient Profile) | Who/what is requesting service |
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. |
locationReference | Σ | 0..* | Reference(Location) | Requested location |
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples |
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
note | S | 0..* | Annotation | Comments |
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | A request for a service to be performed |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Intervention Preferences (extensible) |
orderDetail | ΣI | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |
note | 0..* | Annotation | Comments | |
Documentation for this format |
This structure is derived from ServiceRequest
Differential View
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
status | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Required Pattern: active | |
intent | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: directive | |
doNotPerform | S | 0..1 | boolean | True if service/procedure should not be performed |
code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: Intervention Preferences (extensible) |
orderDetail | S | 0..* | CodeableConcept | Additional order information |
subject | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | |
asNeeded[x] | S | 0..1 | boolean, CodeableConcept | Preconditions for service |
requester | 1..1 | Reference(US Core Patient Profile) | Who/what is requesting service | |
reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | A request for a service to be performed |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces |
requisition | Σ | 0..1 | Identifier | Composite Request ID |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. Required Pattern: active |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Required Pattern: directive |
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
doNotPerform | ?!SΣ | 0..1 | boolean | True if service/procedure should not be performed |
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Intervention Preferences (extensible) |
orderDetail | SΣI | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
quantity[x] | Σ | 0..1 | Service amount | |
quantityQuantity | Quantity | |||
quantityRatio | Ratio | |||
quantityRange | Range | |||
subject | Σ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created |
occurrence[x] | Σ | 0..1 | When service should occur | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
asNeeded[x] | SΣ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | Σ | 0..1 | dateTime | Date request signed |
requester | Σ | 1..1 | Reference(US Core Patient Profile) | Who/what is requesting service |
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. |
locationReference | Σ | 0..* | Reference(Location) | Requested location |
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples |
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
note | S | 0..* | Annotation | Comments |
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
ServiceRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
ServiceRequest.status | required | Pattern: active |
ServiceRequest.intent | required | Pattern: directive |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | extensible | PADIInterventionPreferencesVS |
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
ServiceRequest.performerType | example | ParticipantRoles |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | example | ProcedureReasonCodes |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |