PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0 - STU 2 – Ballot
PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0 - STU 2 – Ballot
PACIO Advance Healthcare Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PMOServiceRequest | Version: 2.0.0 | |||
| Standards status: Trial-use | Computable Name: ADIPMOServiceRequest | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.68.42.27 | ||||
This profile is used to represent both a patient authored care plan (PACP) and a practitioner authored portable medical order (PMO).
Conformance:
ServiceRequest.requester identifies the Practitioner entering the derivative order in their local system based on the patient's PMO, not the author of the original PMO document. The PMO document author is captured in the referenced US Core ADI DocumentReference Profile.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | This is an abstract profile. Child profiles: ADIPMOCPRServiceRequest, ADIPMOAdditionalOrdersOrInstructionsServiceRequest, ADIPMOMedicallyAssistedHydrationServiceRequest, ADIPMOMedicallyAssistedNutritionServiceRequest, ADIPMOInitialTreatmentServiceRequest A request for a service to be performed Constraints: prr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| 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 (extensions allowed) | |
| 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 (extensions allowed) | |
  Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   category:us-core |
0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
 code |
1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible) | |
 subject |
1..1 | Reference(US Core Patient Profile ) | Individual or Entity the service is ordered for | |
 occurrence[x] |
0..1 | When service should occur | ||
| occurrencePeriod |
Period | |||
| occurrenceDateTime |
dateTime | |||
 occurrenceTiming |
Timing | |||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service | |
| reasonReference |
0..* | Reference(ADI Document Reference) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:us-core | Base | required | US Core ServiceRequest Category Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.code | Base | extensible | US Core Procedure Codes | 📦9.0.0 | US Core v9.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | USCoreServiceRequestProfile | This is an abstract profile. Child profiles: ADIPMOCPRServiceRequest, ADIPMOAdditionalOrdersOrInstructionsServiceRequest, ADIPMOMedicallyAssistedHydrationServiceRequest, ADIPMOMedicallyAssistedNutritionServiceRequest, ADIPMOInitialTreatmentServiceRequest A request for a service to be performed | |
 status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Required Pattern: active (extensions allowed) | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: directive (extensions allowed) | |
| category |
1..* | CodeableConcept | Classification of service | |
| subject |
1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | |
| encounter |
0..0 | Encounter in which the request was created | ||
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service | |
| reasonReference |
0..* | Reference(ADI Document Reference) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | This is an abstract profile. Child profiles: ADIPMOCPRServiceRequest, ADIPMOAdditionalOrdersOrInstructionsServiceRequest, ADIPMOMedicallyAssistedHydrationServiceRequest, ADIPMOMedicallyAssistedNutritionServiceRequest, ADIPMOInitialTreatmentServiceRequest A request for a service to be performed Constraints: prr-1 | ||||
| id |
0..1 | id | 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 (extensions allowed) | |||||
| 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 (extensions allowed) | |||||
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:us-core |
0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |||||
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| text |
0..1 | string | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed. | |||||
| orderDetail |
C | 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 | |||||
| occurrence[x] |
0..1 | When service should occur | ||||||
| occurrencePeriod |
Period | |||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceTiming |
Timing | |||||||
| 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 | |||||||
| authoredOn |
0..1 | dateTime | Date request signed | |||||
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole 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 |
0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) | |||||
| reasonReference |
0..* | Reference(ADI Document Reference) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
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 |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:us-core | Base | required | US Core ServiceRequest Category Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | extensible | US Core Procedure Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.4 |
| ServiceRequest.reasonCode | Base | extensible | US Core Condition Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | This is an abstract profile. Child profiles: ADIPMOCPRServiceRequest, ADIPMOAdditionalOrdersOrInstructionsServiceRequest, ADIPMOMedicallyAssistedHydrationServiceRequest, ADIPMOMedicallyAssistedNutritionServiceRequest, ADIPMOInitialTreatmentServiceRequest A request for a service to be performed Constraints: prr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| 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 (extensions allowed) | |
| 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 (extensions allowed) | |
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:us-core |
0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible) | |
| subject |
1..1 | Reference(US Core Patient Profile ) | Individual or Entity the service is ordered for | |
| occurrence[x] |
0..1 | When service should occur | ||
| occurrencePeriod |
Period | |||
| occurrenceDateTime |
dateTime | |||
| occurrenceTiming |
Timing | |||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service | |
| reasonReference |
0..* | Reference(ADI Document Reference) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:us-core | Base | required | US Core ServiceRequest Category Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.code | Base | extensible | US Core Procedure Codes | 📦9.0.0 | US Core v9.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Differential View
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | USCoreServiceRequestProfile | This is an abstract profile. Child profiles: ADIPMOCPRServiceRequest, ADIPMOAdditionalOrdersOrInstructionsServiceRequest, ADIPMOMedicallyAssistedHydrationServiceRequest, ADIPMOMedicallyAssistedNutritionServiceRequest, ADIPMOInitialTreatmentServiceRequest A request for a service to be performed | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Required Pattern: active (extensions allowed) | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: directive (extensions allowed) | |
| category |
1..* | CodeableConcept | Classification of service | |
| subject |
1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | |
| encounter |
0..0 | Encounter in which the request was created | ||
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service | |
| reasonReference |
0..* | Reference(ADI Document Reference) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | This is an abstract profile. Child profiles: ADIPMOCPRServiceRequest, ADIPMOAdditionalOrdersOrInstructionsServiceRequest, ADIPMOMedicallyAssistedHydrationServiceRequest, ADIPMOMedicallyAssistedNutritionServiceRequest, ADIPMOInitialTreatmentServiceRequest A request for a service to be performed Constraints: prr-1 | ||||
| id |
0..1 | id | 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 (extensions allowed) | |||||
| 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 (extensions allowed) | |||||
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:us-core |
0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |||||
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| text |
0..1 | string | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed. | |||||
| orderDetail |
C | 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 | |||||
| occurrence[x] |
0..1 | When service should occur | ||||||
| occurrencePeriod |
Period | |||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceTiming |
Timing | |||||||
| 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 | |||||||
| authoredOn |
0..1 | dateTime | Date request signed | |||||
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole 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 |
0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) | |||||
| reasonReference |
0..* | Reference(ADI Document Reference) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
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 |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:us-core | Base | required | US Core ServiceRequest Category Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | extensible | US Core Procedure Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.4 |
| ServiceRequest.reasonCode | Base | extensible | US Core Condition Codes | 📦9.0.0 | US Core v9.0 |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Patient Empowerment. Package hl7.fhir.us.pacio-adi#2.0.0 based on FHIR 4.0.1. Generated 2026-10-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change