Post-Acute FHIR Based Orders
0.1.0 - STU 1 Ballot

This page is part of the Post Acute Orders FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

StructureDefinition: PAOservicerequest4

Post Acute Orders ServiceRequest Profile

This resource is used to “order” non-DME (device) and non-medications.

For this version of the guide, it is used primarily to order Home Health Services

The official URL for this profile is: 

http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAO-servicerequest4

This section will be expanded in the STU 1 version

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... extension 0..*ExtensionExtension
... identifier S1..*IdentifierIdentifiers assigned to this order
... basedOn 0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces S0..*Reference(PAO ServiceRequest Profile)What request replaces
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order
... category S0..*CodeableConceptClassification of service
... priority S0..1coderoutine | urgent | asap | stat
... code S1..1CodeableConceptWhat is being requested/ordered
... orderDetail S0..*CodeableConceptAdditional order information
... subject S1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter S0..1Reference(US Core Encounter Profile)Encounter in which the request was created
... occurrence[x] S0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] S0..1boolean, CodeableConceptPreconditions for service
... authoredOn S1..1dateTimeDate request signed
... requester S1..1Reference(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 S0..*CodeableConceptRequested location
... locationReference 0..*Reference(US Core Location Profile)Requested location
... reasonCode S0..*CodeableConceptExplanation/Justification for procedure or service
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance S0..*Reference(PAO Coverage)will want to add reference to PA claim response when available
... supportingInfo S0..*Reference(Resource)Additional clinical information
... bodySite S0..*CodeableConceptLocation on Body
... note S0..*AnnotationComments
... patientInstruction S0..1stringPatient or consumer-oriented instructions
... relevantHistory S1..*Reference(PAO Provenance Profile 4b)Request provenance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA request for a service to be performed
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces SΣI0..*Reference(PAO ServiceRequest Profile)What request replaces
... requisition ΣI0..1IdentifierComposite Request ID
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: order
... category SΣI0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority SΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if service/procedure should not be performed
... code SΣI1..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail SΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] ΣI0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣI1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter SΣI0..1Reference(US Core Encounter Profile)Encounter in which the request was created
... occurrence[x] SΣI0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] SΣI0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣI1..1dateTimeDate request signed
... requester SΣI1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... performerType ΣI0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer ΣI0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile)Requested performer
... locationCode SΣI0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference ΣI0..*Reference(US Core Location Profile)Requested location
... reasonCode SΣI0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference SΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance SI0..*Reference(PAO Coverage)will want to add reference to PA claim response when available
... supportingInfo SI0..*Reference(Resource)Additional clinical information
... specimen ΣI0..*Reference(Specimen)Procedure Samples
... bodySite SΣI0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note SI0..*AnnotationComments
... patientInstruction SΣI0..1stringPatient or consumer-oriented instructions
... relevantHistory SI1..*Reference(PAO Provenance Profile 4b)Request provenance

doco Documentation for this format

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... extension 0..*ExtensionExtension
... identifier S1..*IdentifierIdentifiers assigned to this order
... basedOn 0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces S0..*Reference(PAO ServiceRequest Profile)What request replaces
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order
... category S0..*CodeableConceptClassification of service
... priority S0..1coderoutine | urgent | asap | stat
... code S1..1CodeableConceptWhat is being requested/ordered
... orderDetail S0..*CodeableConceptAdditional order information
... subject S1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter S0..1Reference(US Core Encounter Profile)Encounter in which the request was created
... occurrence[x] S0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] S0..1boolean, CodeableConceptPreconditions for service
... authoredOn S1..1dateTimeDate request signed
... requester S1..1Reference(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 S0..*CodeableConceptRequested location
... locationReference 0..*Reference(US Core Location Profile)Requested location
... reasonCode S0..*CodeableConceptExplanation/Justification for procedure or service
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance S0..*Reference(PAO Coverage)will want to add reference to PA claim response when available
... supportingInfo S0..*Reference(Resource)Additional clinical information
... bodySite S0..*CodeableConceptLocation on Body
... note S0..*AnnotationComments
... patientInstruction S0..1stringPatient or consumer-oriented instructions
... relevantHistory S1..*Reference(PAO Provenance Profile 4b)Request provenance

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA request for a service to be performed
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces SΣI0..*Reference(PAO ServiceRequest Profile)What request replaces
... requisition ΣI0..1IdentifierComposite Request ID
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: order
... category SΣI0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority SΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if service/procedure should not be performed
... code SΣI1..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail SΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] ΣI0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣI1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter SΣI0..1Reference(US Core Encounter Profile)Encounter in which the request was created
... occurrence[x] SΣI0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] SΣI0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣI1..1dateTimeDate request signed
... requester SΣI1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... performerType ΣI0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer ΣI0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile)Requested performer
... locationCode SΣI0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference ΣI0..*Reference(US Core Location Profile)Requested location
... reasonCode SΣI0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference SΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance SI0..*Reference(PAO Coverage)will want to add reference to PA claim response when available
... supportingInfo SI0..*Reference(Resource)Additional clinical information
... specimen ΣI0..*Reference(Specimen)Procedure Samples
... bodySite SΣI0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note SI0..*AnnotationComments
... patientInstruction SΣI0..1stringPatient or consumer-oriented instructions
... relevantHistory SI1..*Reference(PAO Provenance Profile 4b)Request provenance

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
ServiceRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredFixed Value: order
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexamplev3.ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeexampleProcedureReasonCodes
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

Constraints

Constraints

IdPathDetailsRequirements
dom-2ServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ServiceRequestIf 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-4ServiceRequestIf 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-5ServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
prr-1ServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
ele-1ServiceRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ServiceRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ServiceRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ServiceRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ServiceRequest.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.replacesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.requisitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.intentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.doNotPerformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.orderDetailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.quantity[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.asNeeded[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.authoredOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.requesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.performerTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.locationCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.locationReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.insuranceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.supportingInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.patientInstructionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ServiceRequest.relevantHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This section will be expanded in the STU 1 version