2.0.0 - release

SHINNYHRSN - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SHINNY SDOH Service Request

Official URL: http://test.shinny.org/us/ny/hrsn/StructureDefinition/SHINNYSDOHServiceRequest Version: 2.0.0
Active as of 2026-08-20 Computable Name: SHINNYSDOHServiceRequest

  • SHINNY HRSN: Needed for Referrals. Include in Service Request and Task bundles.
  • Profiled off of the SDOHCC Service Request: Profile for service requests that address Social Determinants of Health.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* SDOHCCServiceRequest A request for a service to address an SDOH condition, observation or goal.
Constraints: prr-1
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version was created or last changed
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:pertainsToGoal S 0..* (Complex) Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest) What request fulfills
Slice: Unordered, Open by profile:resolve()
.... basedOn:SupportedBasedOn SΣ 0..* Reference(SDOHCC ServiceRequest) What request fulfills
... 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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: USCoreServiceRequestCategoryCodes (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
.... category:SDOHCC SΣ 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
... 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Σ 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
DigitalAccessServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-access
DigitalLiteracyServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-literacy
LessThanHighSchoolEducationServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = educational-attainment
ElderAbuseServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = elder-abuse
UnemploymentServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = employment-status
FinancialInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = financial-insecurity
FoodInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = food-insecurity
HealthInsuranceCoverageStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = health-insurance-coverage-status
HomelessnessServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = homelessness
HousingInstabilityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = housing-instability
InadequateHousingServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = inadequate-housing
Incarceration Status Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = incarceration-status
IntimatePartnerViolenceServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = intimate-partner-violence
Language Access Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = language-access
MaterialHardshipServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = material-hardship
MedicalCostBurdenServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = medical-cost-burden
HealthLiteracyServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = personal-health-literacy
SocialConnectionServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = social-connection
StressServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = stress
TransportationInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = transportation-insecurity
UtilityInsecurityServiceRequests (20240524) . Extensible SDOHCCServiceRequest#ServiceRequest.category = utility-insecurity
VeteranStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required SDOHCCServiceRequest#ServiceRequest.category = sdoh-category-unspecified
... Slices for orderDetail ΣC 0..* CodeableConcept Additional order information
Slice: Unordered, Open by value:coding
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... orderDetail:SubjectContactDetail SΣC 0..1 CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Group | US Core Patient Profile(7.0.0) | US Core Location Profile(7.0.0)) Individual or Entity the service is ordered for
... encounter SΣ 1..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
... occurrence[x] SΣ 0..1 When service should occur
.... occurrencePeriod Period S
.... occurrenceDateTime dateTime S
.... occurrenceTiming Timing
... authoredOn SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(US Core RelatedPerson Profile(7.0.0) | Device | SDOHCC PractitionerRole | US Core Practitioner Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Organization Profile(7.0.0)) Who/what is requesting service
... performer SΣ 0..* Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Requested performer
... Slices for reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
Slice: Unordered, Open by profile:resolve()
.... reasonReference:SupportedReasonReference SΣ 0..* Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:SupportedSupportingInfo S 0..* Reference(SDOHCC Consent) Additional clinical information

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred SHINNYLanguageVS 📦2.0.0 This IG
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 📍7.0.0 US Core v7.0
ServiceRequest.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦2.3.0 SDOH Clinical Care v2.3
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base required US Core Procedure Codes 📍7.0.0 US Core v7.0
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.
ServiceRequest.orderDetail:SubjectContactDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.

Constraints

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 SDOHCCServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* SDOHCCServiceRequest A request for a service to address an SDOH condition, observation or goal.
... id S 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta S 1..1 SHINNYMeta Metadata about the resource
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... language 0..1 code Language of the resource content
Binding: SHINNYLanguageVS (preferred)
... Slices for category Content/Rules for all slices
.... category:SDOHCC 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
... encounter 1..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
... requester 1..1 Reference(US Core RelatedPerson Profile(7.0.0) | Device | SDOHCC PractitionerRole | US Core Practitioner Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Organization Profile(7.0.0)) Who/what is requesting service

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred SHINNYLanguageVS 📦2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* SDOHCCServiceRequest A request for a service to address an SDOH condition, observation or goal.
Constraints: prr-1
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version was created or last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: SHINNYLanguageVS (preferred)
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pertainsToGoal S 0..* (Complex) Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
... 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
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest) What request fulfills
Slice: Unordered, Open by profile:resolve()
.... basedOn:SupportedBasedOn SΣ 0..* Reference(SDOHCC ServiceRequest) What request fulfills
... replaces Σ 0..* Reference(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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: USCoreServiceRequestCategoryCodes (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
.... category:SDOHCC SΣ 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
... 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Σ 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
DigitalAccessServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-access
DigitalLiteracyServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-literacy
LessThanHighSchoolEducationServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = educational-attainment
ElderAbuseServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = elder-abuse
UnemploymentServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = employment-status
FinancialInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = financial-insecurity
FoodInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = food-insecurity
HealthInsuranceCoverageStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = health-insurance-coverage-status
HomelessnessServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = homelessness
HousingInstabilityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = housing-instability
InadequateHousingServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = inadequate-housing
Incarceration Status Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = incarceration-status
IntimatePartnerViolenceServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = intimate-partner-violence
Language Access Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = language-access
MaterialHardshipServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = material-hardship
MedicalCostBurdenServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = medical-cost-burden
HealthLiteracyServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = personal-health-literacy
SocialConnectionServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = social-connection
StressServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = stress
TransportationInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = transportation-insecurity
UtilityInsecurityServiceRequests (20240524) . Extensible SDOHCCServiceRequest#ServiceRequest.category = utility-insecurity
VeteranStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required SDOHCCServiceRequest#ServiceRequest.category = sdoh-category-unspecified
... Slices for orderDetail ΣC 0..* CodeableConcept Additional order information
Slice: Unordered, Open by value:coding
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... orderDetail:SubjectContactDetail SΣC 0..1 CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Group | US Core Patient Profile(7.0.0) | US Core Location Profile(7.0.0)) Individual or Entity the service is ordered for
... encounter SΣ 1..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
... occurrence[x] SΣ 0..1 When service should occur
.... occurrencePeriod Period S
.... occurrenceDateTime dateTime S
.... 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(US Core RelatedPerson Profile(7.0.0) | Device | SDOHCC PractitionerRole | US Core Practitioner Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Organization Profile(7.0.0)) 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 SΣ 0..* Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered.
... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode Σ 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
Binding: USCoreConditionCodes (7.0.0) (extensible)
... Slices for reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
Slice: Unordered, Open by profile:resolve()
.... reasonReference:SupportedReasonReference SΣ 0..* Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:SupportedSupportingInfo S 0..* Reference(SDOHCC Consent) Additional clinical information
... note 0..* Annotation Comments
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ServiceRequest.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ServiceRequest.language Base preferred SHINNYLanguageVS 📦2.0.0 This IG
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 📍7.0.0 US Core v7.0
ServiceRequest.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦2.3.0 SDOH Clinical Care v2.3
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base required US Core Procedure Codes 📍7.0.0 US Core v7.0
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.
ServiceRequest.orderDetail:SubjectContactDetail 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.3
ServiceRequest.reasonCode Base extensible US Core Condition Codes 📍7.0.0 US Core v7.0

Constraints

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 SDOHCCServiceRequest

Summary

Mandatory: 6 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* SDOHCCServiceRequest A request for a service to address an SDOH condition, observation or goal.
Constraints: prr-1
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version was created or last changed
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:pertainsToGoal S 0..* (Complex) Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest) What request fulfills
Slice: Unordered, Open by profile:resolve()
.... basedOn:SupportedBasedOn SΣ 0..* Reference(SDOHCC ServiceRequest) What request fulfills
... 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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: USCoreServiceRequestCategoryCodes (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
.... category:SDOHCC SΣ 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
... 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Σ 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
DigitalAccessServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-access
DigitalLiteracyServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-literacy
LessThanHighSchoolEducationServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = educational-attainment
ElderAbuseServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = elder-abuse
UnemploymentServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = employment-status
FinancialInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = financial-insecurity
FoodInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = food-insecurity
HealthInsuranceCoverageStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = health-insurance-coverage-status
HomelessnessServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = homelessness
HousingInstabilityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = housing-instability
InadequateHousingServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = inadequate-housing
Incarceration Status Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = incarceration-status
IntimatePartnerViolenceServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = intimate-partner-violence
Language Access Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = language-access
MaterialHardshipServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = material-hardship
MedicalCostBurdenServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = medical-cost-burden
HealthLiteracyServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = personal-health-literacy
SocialConnectionServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = social-connection
StressServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = stress
TransportationInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = transportation-insecurity
UtilityInsecurityServiceRequests (20240524) . Extensible SDOHCCServiceRequest#ServiceRequest.category = utility-insecurity
VeteranStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required SDOHCCServiceRequest#ServiceRequest.category = sdoh-category-unspecified
... Slices for orderDetail ΣC 0..* CodeableConcept Additional order information
Slice: Unordered, Open by value:coding
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... orderDetail:SubjectContactDetail SΣC 0..1 CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Group | US Core Patient Profile(7.0.0) | US Core Location Profile(7.0.0)) Individual or Entity the service is ordered for
... encounter SΣ 1..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
... occurrence[x] SΣ 0..1 When service should occur
.... occurrencePeriod Period S
.... occurrenceDateTime dateTime S
.... occurrenceTiming Timing
... authoredOn SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(US Core RelatedPerson Profile(7.0.0) | Device | SDOHCC PractitionerRole | US Core Practitioner Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Organization Profile(7.0.0)) Who/what is requesting service
... performer SΣ 0..* Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Requested performer
... Slices for reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
Slice: Unordered, Open by profile:resolve()
.... reasonReference:SupportedReasonReference SΣ 0..* Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:SupportedSupportingInfo S 0..* Reference(SDOHCC Consent) Additional clinical information

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred SHINNYLanguageVS 📦2.0.0 This IG
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 📍7.0.0 US Core v7.0
ServiceRequest.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦2.3.0 SDOH Clinical Care v2.3
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base required US Core Procedure Codes 📍7.0.0 US Core v7.0
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.
ServiceRequest.orderDetail:SubjectContactDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.

Constraints

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 SDOHCCServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* SDOHCCServiceRequest A request for a service to address an SDOH condition, observation or goal.
... id S 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta S 1..1 SHINNYMeta Metadata about the resource
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... language 0..1 code Language of the resource content
Binding: SHINNYLanguageVS (preferred)
... Slices for category Content/Rules for all slices
.... category:SDOHCC 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
... encounter 1..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
... requester 1..1 Reference(US Core RelatedPerson Profile(7.0.0) | Device | SDOHCC PractitionerRole | US Core Practitioner Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Organization Profile(7.0.0)) Who/what is requesting service

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred SHINNYLanguageVS 📦2.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* SDOHCCServiceRequest A request for a service to address an SDOH condition, observation or goal.
Constraints: prr-1
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version was created or last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: SHINNYLanguageVS (preferred)
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pertainsToGoal S 0..* (Complex) Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
... 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
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest) What request fulfills
Slice: Unordered, Open by profile:resolve()
.... basedOn:SupportedBasedOn SΣ 0..* Reference(SDOHCC ServiceRequest) What request fulfills
... replaces Σ 0..* Reference(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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: USCoreServiceRequestCategoryCodes (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
.... category:SDOHCC SΣ 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
... 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Σ 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
DigitalAccessServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-access
DigitalLiteracyServiceRequests (20240615) . Extensible SDOHCCServiceRequest#ServiceRequest.category = digital-literacy
LessThanHighSchoolEducationServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = educational-attainment
ElderAbuseServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = elder-abuse
UnemploymentServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = employment-status
FinancialInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = financial-insecurity
FoodInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = food-insecurity
HealthInsuranceCoverageStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = health-insurance-coverage-status
HomelessnessServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = homelessness
HousingInstabilityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = housing-instability
InadequateHousingServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = inadequate-housing
Incarceration Status Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = incarceration-status
IntimatePartnerViolenceServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = intimate-partner-violence
Language Access Service Requests . Extensible SDOHCCServiceRequest#ServiceRequest.category = language-access
MaterialHardshipServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = material-hardship
MedicalCostBurdenServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = medical-cost-burden
HealthLiteracyServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = personal-health-literacy
SocialConnectionServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = social-connection
StressServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = stress
TransportationInsecurityServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = transportation-insecurity
UtilityInsecurityServiceRequests (20240524) . Extensible SDOHCCServiceRequest#ServiceRequest.category = utility-insecurity
VeteranStatusServiceRequests (20240604) . Extensible SDOHCCServiceRequest#ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required SDOHCCServiceRequest#ServiceRequest.category = sdoh-category-unspecified
... Slices for orderDetail ΣC 0..* CodeableConcept Additional order information
Slice: Unordered, Open by value:coding
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... orderDetail:SubjectContactDetail SΣC 0..1 CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Group | US Core Patient Profile(7.0.0) | US Core Location Profile(7.0.0)) Individual or Entity the service is ordered for
... encounter SΣ 1..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
... occurrence[x] SΣ 0..1 When service should occur
.... occurrencePeriod Period S
.... occurrenceDateTime dateTime S
.... 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(US Core RelatedPerson Profile(7.0.0) | Device | SDOHCC PractitionerRole | US Core Practitioner Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Organization Profile(7.0.0)) 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 SΣ 0..* Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered.
... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode Σ 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
Binding: USCoreConditionCodes (7.0.0) (extensible)
... Slices for reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
Slice: Unordered, Open by profile:resolve()
.... reasonReference:SupportedReasonReference SΣ 0..* Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:SupportedSupportingInfo S 0..* Reference(SDOHCC Consent) Additional clinical information
... note 0..* Annotation Comments
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ServiceRequest.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ServiceRequest.language Base preferred SHINNYLanguageVS 📦2.0.0 This IG
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 📍7.0.0 US Core v7.0
ServiceRequest.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦2.3.0 SDOH Clinical Care v2.3
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base required US Core Procedure Codes 📍7.0.0 US Core v7.0
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.
ServiceRequest.orderDetail:SubjectContactDetail 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.3
ServiceRequest.reasonCode Base extensible US Core Condition Codes 📍7.0.0 US Core v7.0

Constraints

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 SDOHCCServiceRequest

Summary

Mandatory: 6 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron