FHIR Orders Exchange (FOE) / Post-Acute Orders (PAO) / (DME-Orders), published by HL7. This is not an authorized publication; it is the continuous build for version 0.2.2). This version is based on the current content of https://github.com/HL7/dme-orders/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAOX-servicerequest | Version: 0.2.2 | |||
Active as of 2023-06-25 | Computable Name: PAOxServiceRequest |
This resource is used to “order” services (e.g. non-DME (device) and non-medications).
For this version of the IG, it is used primarily to order Home Health Services.
Purpose
Intro
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
replaces | S | 0..* | Reference(PAO ServiceRequest) | What request replaces |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
category | S | 0..* | CodeableConcept | Classification of service |
priority | S | 0..1 | code | routine | urgent | asap | stat |
code | S | 0..1 | CodeableConcept | What is being requested/ordered |
orderDetail | S | 0..* | CodeableConcept | Additional order information |
subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
encounter | S | 0..1 | Reference(US Core Encounter Profile) | Encounter in which the request was created |
occurrence[x] | S | 0..1 | dateTime, Period, Timing | When service should occur |
asNeeded[x] | S | 0..1 | boolean, CodeableConcept | Preconditions for service |
authoredOn | S | 1..1 | dateTime | Date request signed |
requester | S | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
performer | 0..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer | |
locationCode | S | 0..* | CodeableConcept | Requested location |
locationReference | 0..* | Reference(US Core Location Profile) | Requested location | |
reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
insurance | S | 0..* | Reference(PAO Coverage) | Associated insurance coverage |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
bodySite | S | 0..* | CodeableConcept | Location on Body |
note | S | 0..* | Annotation | Comments |
patientInstruction | S | 0..1 | string | Patient or consumer-oriented instructions |
relevantHistory | S | 0..* | Reference(PAO Provenance) | Request provenance |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order |
replaces | SΣ | 0..* | Reference(PAO ServiceRequest) | What request replaces |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order |
category | SΣ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
priority | SΣ | 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 | SΣ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. |
orderDetail | SΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
encounter | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter in which the request was created |
occurrence[x] | SΣ | 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 | SΣ | 1..1 | dateTime | Date request signed |
requester | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
performer | Σ | 0..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer |
locationCode | SΣ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. |
locationReference | Σ | 0..* | Reference(US Core Location Profile) | 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 | SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
insurance | S | 0..* | Reference(PAO Coverage) | Associated insurance coverage |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
note | S | 0..* | Annotation | Comments |
patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions |
relevantHistory | S | 0..* | Reference(PAO Provenance) | Request provenance |
Documentation for this format |
Path | Conformance | ValueSet / Code |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Fixed Value: order |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | example | ProcedureReasonCodes |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 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 | SΣ | 0..* | Reference(PAO ServiceRequest) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
category | SΣ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
priority | SΣ | 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 | SΣ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
orderDetail | SΣ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 | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
encounter | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter in which the request was created | ||||
occurrence[x] | SΣ | 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 | SΣ | 1..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization 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(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer | ||||
locationCode | SΣ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(US Core Location Profile) | 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 | SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | S | 0..* | Reference(PAO Coverage) | Associated insurance coverage | ||||
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information | ||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | S | 0..* | Annotation | Comments | ||||
patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | S | 0..* | Reference(PAO Provenance) | Request provenance | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
ServiceRequest.language | preferred | CommonLanguages
| ||||
ServiceRequest.status | required | RequestStatus | ||||
ServiceRequest.intent | required | Fixed Value: order | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
ServiceRequest.priority | required | RequestPriority | ||||
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) | ||||
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 |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from ServiceRequest
Summary
Mandatory: 2 elements
Must-Support: 23 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
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 | |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
replaces | S | 0..* | Reference(PAO ServiceRequest) | What request replaces |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
category | S | 0..* | CodeableConcept | Classification of service |
priority | S | 0..1 | code | routine | urgent | asap | stat |
code | S | 0..1 | CodeableConcept | What is being requested/ordered |
orderDetail | S | 0..* | CodeableConcept | Additional order information |
subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
encounter | S | 0..1 | Reference(US Core Encounter Profile) | Encounter in which the request was created |
occurrence[x] | S | 0..1 | dateTime, Period, Timing | When service should occur |
asNeeded[x] | S | 0..1 | boolean, CodeableConcept | Preconditions for service |
authoredOn | S | 1..1 | dateTime | Date request signed |
requester | S | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
performer | 0..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer | |
locationCode | S | 0..* | CodeableConcept | Requested location |
locationReference | 0..* | Reference(US Core Location Profile) | Requested location | |
reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
insurance | S | 0..* | Reference(PAO Coverage) | Associated insurance coverage |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
bodySite | S | 0..* | CodeableConcept | Location on Body |
note | S | 0..* | Annotation | Comments |
patientInstruction | S | 0..1 | string | Patient or consumer-oriented instructions |
relevantHistory | S | 0..* | Reference(PAO Provenance) | Request provenance |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order |
replaces | SΣ | 0..* | Reference(PAO ServiceRequest) | What request replaces |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order |
category | SΣ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
priority | SΣ | 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 | SΣ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. |
orderDetail | SΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
encounter | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter in which the request was created |
occurrence[x] | SΣ | 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 | SΣ | 1..1 | dateTime | Date request signed |
requester | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
performer | Σ | 0..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer |
locationCode | SΣ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. |
locationReference | Σ | 0..* | Reference(US Core Location Profile) | 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 | SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
insurance | S | 0..* | Reference(PAO Coverage) | Associated insurance coverage |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
note | S | 0..* | Annotation | Comments |
patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions |
relevantHistory | S | 0..* | Reference(PAO Provenance) | Request provenance |
Documentation for this format |
Path | Conformance | ValueSet / Code |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Fixed Value: order |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | example | ProcedureReasonCodes |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 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 | SΣ | 0..* | Reference(PAO ServiceRequest) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
category | SΣ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
priority | SΣ | 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 | SΣ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
orderDetail | SΣ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 | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
encounter | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter in which the request was created | ||||
occurrence[x] | SΣ | 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 | SΣ | 1..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization 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(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer | ||||
locationCode | SΣ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(US Core Location Profile) | 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 | SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | S | 0..* | Reference(PAO Coverage) | Associated insurance coverage | ||||
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information | ||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | S | 0..* | Annotation | Comments | ||||
patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | S | 0..* | Reference(PAO Provenance) | Request provenance | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
ServiceRequest.language | preferred | CommonLanguages
| ||||
ServiceRequest.status | required | RequestStatus | ||||
ServiceRequest.intent | required | Fixed Value: order | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
ServiceRequest.priority | required | RequestPriority | ||||
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) | ||||
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 |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from ServiceRequest
Summary
Mandatory: 2 elements
Must-Support: 23 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
Notes