Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm

This page is part of the electronic Long-Term Services and Supports Implementation Guide (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition: ServiceRequest_eltss

The official URL for this profile is:

http://hl7.org/fhir/us/eltss/StructureDefinition/ServiceRequest-eltss

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..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... eltss-directedBy 0..*CodeableConceptSelf-Directed Service Indicator
URL: http://hl7.org/fhir/us/eltss/StructureDefinition/eltss-directedBy
... basedOn 0..*Reference(CarePlan_eltss | ServiceRequest_eltss | MedicationRequest)
... replaces 0..*Reference(ServiceRequest_eltss)
... code 0..1CodeableConceptService Name
... quantity[x]:eltss 0..1Quantity, Ratio, RangeService Unit Quantity + Unit Type + Time Interval
... subject 1..1Reference(Patient_eltss | Group | US Core Device Profile | Location_eltss)
... encounter 0..1Reference(US Core Encounter Profile)
... occurrence[x]:eltss 0..1dateTime, Period, TimingService Start + End Date
... requester 0..1Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile)
... performer 0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile | US Core CareTeam Profile | HealthcareService)Service Provider Name + Phone + Relationship
... locationReference 0..*Reference(Location_eltss)Service Location
... reasonReference 0..*Reference(Condition_eltss | Observation_eltss | US Core DiagnosticReport Profile for Report and Note exchange | US Core DocumentReference Profile)
... insurance 0..*Reference(Coverage | ClaimResponse)Service Funding Source
... note 0..*AnnotationService Comment

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*A request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... eltss-directedBy I0..*CodeableConceptSelf-Directed Service Indicator
URL: http://hl7.org/fhir/us/eltss/StructureDefinition/eltss-directedBy
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan_eltss | ServiceRequest_eltss | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest_eltss)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... category Σ0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ0..1CodeableConceptService Name
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x]:eltss Σ0..1Service Unit Quantity + Unit Type + Time Interval
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject Σ1..1Reference(Patient_eltss | Group | US Core Device Profile | Location_eltss)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(US Core Encounter Profile)Encounter in which the request was created
... occurrence[x]:eltss Σ0..1Service Start + End Date
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer Σ0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile | US Core CareTeam Profile | HealthcareService)Service Provider Name + Phone + Relationship
... locationCode Σ0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference Σ0..*Reference(Location_eltss)Service Location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference Σ0..*Reference(Condition_eltss | Observation_eltss | US Core DiagnosticReport Profile for Report and Note exchange | US Core DocumentReference Profile)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Service Funding Source
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note 0..*AnnotationService Comment
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... eltss-directedBy 0..*CodeableConceptSelf-Directed Service Indicator
URL: http://hl7.org/fhir/us/eltss/StructureDefinition/eltss-directedBy
... basedOn 0..*Reference(CarePlan_eltss | ServiceRequest_eltss | MedicationRequest)
... replaces 0..*Reference(ServiceRequest_eltss)
... code 0..1CodeableConceptService Name
... quantity[x]:eltss 0..1Quantity, Ratio, RangeService Unit Quantity + Unit Type + Time Interval
... subject 1..1Reference(Patient_eltss | Group | US Core Device Profile | Location_eltss)
... encounter 0..1Reference(US Core Encounter Profile)
... occurrence[x]:eltss 0..1dateTime, Period, TimingService Start + End Date
... requester 0..1Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile)
... performer 0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile | US Core CareTeam Profile | HealthcareService)Service Provider Name + Phone + Relationship
... locationReference 0..*Reference(Location_eltss)Service Location
... reasonReference 0..*Reference(Condition_eltss | Observation_eltss | US Core DiagnosticReport Profile for Report and Note exchange | US Core DocumentReference Profile)
... insurance 0..*Reference(Coverage | ClaimResponse)Service Funding Source
... note 0..*AnnotationService Comment

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*A request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... eltss-directedBy I0..*CodeableConceptSelf-Directed Service Indicator
URL: http://hl7.org/fhir/us/eltss/StructureDefinition/eltss-directedBy
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan_eltss | ServiceRequest_eltss | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest_eltss)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | suspended | completed | entered-in-error | cancelled
Binding: RequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order +
Binding: RequestIntent (required)
... category Σ0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ0..1CodeableConceptService Name
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x]:eltss Σ0..1Service Unit Quantity + Unit Type + Time Interval
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject Σ1..1Reference(Patient_eltss | Group | US Core Device Profile | Location_eltss)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(US Core Encounter Profile)Encounter in which the request was created
... occurrence[x]:eltss Σ0..1Service Start + End Date
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
... performer Σ0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | Patient_eltss | US Core Organization Profile | RelatedPerson | US Core Device Profile | US Core CareTeam Profile | HealthcareService)Service Provider Name + Phone + Relationship
... locationCode Σ0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference Σ0..*Reference(Location_eltss)Service Location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference Σ0..*Reference(Condition_eltss | Observation_eltss | US Core DiagnosticReport Profile for Report and Note exchange | US Core DocumentReference Profile)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Service Funding Source
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note 0..*AnnotationService Comment
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

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

Constraints

IdPathDetailsRequirements
dom-2ServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.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-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-6ServiceRequestA resource should have narrative for robust management
: text.div.exists()
dom-5ServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
prr-1ServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
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.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()