SDOH Clinical Care
2.3.0 - STU 2.3 United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions

Resource Profile: SDOHCC ServiceRequest

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest Version: 2.3.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SDOHCCServiceRequest

Profile for service requests that address Social Determinants of Health.

Purpose

SDOHCC ServiceRequest is generally intended to represent a service request to address an identified social risk or need (e.g., SDOHCC Condition, SDOHCC Observation Screening Response, SDOHCC Observation Assessment). An SDOHCC ServiceRequest can pertain to an SDOHCC Goal, and can reference the patient’s consent for the referral (e.g., SDOHCC Consent). An SDOHCC ServiceRequest can be the focus of an SDOHCC Task For Referral Management and an SDOHCC Procedure can be an based on an SDOHCC ServiceRequest. See the Data Modeling Framework for more detail on the relationships between SDOHCC ServiceRequest and the other profiles in this IG.

Usage

ServiceRequest.code has a binding to US Core Procedure Codes (required). ServiceRequest.code also has additional bindings to SDOH domain-specific value sets (e.g., for Food Insecurity) which are determined by the value selected for ServiceRequest.category. When ServiceRequest.category is a value from SDOHCC ValueSet SDOH Category (e.g., food-insecurity), ServiceRequest.code SHALL be selected from the corresponding domain-specific value set found in Additional Bindings (i.e. Food Insecurity ServiceRequests). If more than one value is selected from SDOHCC ValueSet SDOH Category (e.g., food-insecurity and financial-insecurity) for ServiceRequest.category, then ServiceRequest.code SHALL be selected from at least one of the corresponding domain-specific value sets found in Additional Bindings (e.g. Food Insecurity ServiceRequests).

Of note, Gravity Project is continuously developing terminology for new SDOH domains. Sometimes, a new SDOH domain may already be represented by a category code in SDOHCC ValueSet SDOH Category, but a domain-specific value set may not yet be available in VSAC. In this case, the Additional Binding for the new SDOH domain/category is the default binding for the profile element. Additionally, sometimes a domain-specific value set for a new domain is available in VSAC but does not yet include all standardized codes identified during the domain’s terminology development cycle. In this case, the value set’s “Description” tab in VSAC will state, “In progress”. Additional information related to Gravity value sets is provided on the Social Risk Terminology Value Sets page on the Gravity Project Confluence site.

Additionally, some SDOH domains may not yet be represented in SDOHCC ValueSet SDOH Category. In this case, ServiceRequest.category: sdoh-category-unspecified can be used so that the Service Request instance can still be categorized as SDOH-related. If desired, category.text can also be used to further specify the domain. For example, at the time of publication of this IG, “disability-status” is not yet included in SDOHCC ValueSet SDOH Category. In this case, ServiceRequest.category: sdoh-category-unspecified can be used along with category.text: Disability Status. For ServiceRequest.category: sdoh-category-unspecified, there will not be domain-specific value sets and Additional Bindings for ServiceRequest.code will designate the default binding to US Core Procedure Codes (required).

For more information on the correlation between ServiceRequest.category and the domain-specific value sets in Additional Bindings for ServiceRequest.code, see Gravity Project Value Sets.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile(7.0.0) A request for a service to address an SDOH condition, observation or goal.
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:pertainsToGoal S 0..* (Complex) Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... basedOn:SupportedBasedOn SΣ 0..* Reference(SDOHCC ServiceRequest) What request fulfills
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ele-1: All FHIR elements must have a @value or children
.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


ele-1: All FHIR elements must have a @value or children
.... category:SDOHCC SΣ 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.


ele-1: All FHIR elements must have a @value or children
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.


ele-1: All FHIR elements must have a @value or children
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
Digital Access Service Requests . Extensible ServiceRequest.category = digital-access
Digital Literacy Service Requests . Extensible ServiceRequest.category = digital-literacy
Less Than High School Education Service Requests . Extensible ServiceRequest.category = educational-attainment
Elder Abuse Service Requests . Extensible ServiceRequest.category = elder-abuse
Unemployment Service Requests . Extensible ServiceRequest.category = employment-status
Financial Insecurity Service Requests . Extensible ServiceRequest.category = financial-insecurity
Food Insecurity Service Requests . Extensible ServiceRequest.category = food-insecurity
Health Insurance Coverage Status Service Requests . Extensible ServiceRequest.category = health-insurance-coverage-status
Homelessness Service Requests . Extensible ServiceRequest.category = homelessness
Housing Instability Service Requests . Extensible ServiceRequest.category = housing-instability
Inadequate Housing Service Requests . Extensible ServiceRequest.category = inadequate-housing
VSAC 2.16.840.1.113762.1.4.1247.261 . Extensible ServiceRequest.category = incarceration-status
Intimate Partner Violence Service Requests . Extensible ServiceRequest.category = intimate-partner-violence
VSAC 2.16.840.1.113762.1.4.1247.269 . Extensible ServiceRequest.category = language-access
Material Hardship Service Requests . Extensible ServiceRequest.category = material-hardship
Medical Cost Burden Service Requests . Extensible ServiceRequest.category = medical-cost-burden
Health Literacy Service Requests . Extensible ServiceRequest.category = personal-health-literacy
Social Connection Service Requests . Extensible ServiceRequest.category = social-connection
Stress Service Requests . Extensible ServiceRequest.category = stress
Transportation Insecurity Service Requests . Extensible ServiceRequest.category = transportation-insecurity
Utility Insecurity Service Requests . Extensible ServiceRequest.category = utility-insecurity
Veteran Status Service Requests . Extensible ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required ServiceRequest.category = sdoh-category-unspecified

ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
.... orderDetail:SubjectContactDetail SΣC 0..1 CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
... 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
ele-1: All FHIR elements must have a @value or children
... encounter SΣ 0..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
ele-1: All FHIR elements must have a @value or children
... occurrence[x] SΣ 0..1 When service should occur
ele-1: All FHIR elements must have a @value or children
.... occurrencePeriod Period
.... occurrenceDateTime dateTime
... authoredOn SΣ 0..1 dateTime Date request signed
ele-1: All FHIR elements must have a @value or children
... requester SΣ 0..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
ele-1: All FHIR elements must have a @value or children
... 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
ele-1: All FHIR elements must have a @value or children
... reasonCode Σ 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
ele-1: All FHIR elements must have a @value or children
... Slices for reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... reasonReference:SupportedReasonReference SΣ 0..* Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
ele-1: All FHIR elements must have a @value or children
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:SupportedSupportingInfo S 0..* Reference(SDOHCC Consent) Additional clinical information
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.category:SDOHCCrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.orderDetail:SubjectContactDetailexamplePattern: contacting-subject-prohibited
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from USCoreServiceRequestProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* USCoreServiceRequestProfile(7.0.0) A request for a service to address an SDOH condition, observation or goal.
... 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
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
... 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 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... category 1..* CodeableConcept Classification of service
... Slices for category Content/Rules for all slices
.... 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
... code 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
Digital Access Service Requests . Extensible ServiceRequest.category = digital-access
Digital Literacy Service Requests . Extensible ServiceRequest.category = digital-literacy
Less Than High School Education Service Requests . Extensible ServiceRequest.category = educational-attainment
Elder Abuse Service Requests . Extensible ServiceRequest.category = elder-abuse
Unemployment Service Requests . Extensible ServiceRequest.category = employment-status
Financial Insecurity Service Requests . Extensible ServiceRequest.category = financial-insecurity
Food Insecurity Service Requests . Extensible ServiceRequest.category = food-insecurity
Health Insurance Coverage Status Service Requests . Extensible ServiceRequest.category = health-insurance-coverage-status
Homelessness Service Requests . Extensible ServiceRequest.category = homelessness
Housing Instability Service Requests . Extensible ServiceRequest.category = housing-instability
Inadequate Housing Service Requests . Extensible ServiceRequest.category = inadequate-housing
VSAC 2.16.840.1.113762.1.4.1247.261 . Extensible ServiceRequest.category = incarceration-status
Intimate Partner Violence Service Requests . Extensible ServiceRequest.category = intimate-partner-violence
VSAC 2.16.840.1.113762.1.4.1247.269 . Extensible ServiceRequest.category = language-access
Material Hardship Service Requests . Extensible ServiceRequest.category = material-hardship
Medical Cost Burden Service Requests . Extensible ServiceRequest.category = medical-cost-burden
Health Literacy Service Requests . Extensible ServiceRequest.category = personal-health-literacy
Social Connection Service Requests . Extensible ServiceRequest.category = social-connection
Stress Service Requests . Extensible ServiceRequest.category = stress
Transportation Insecurity Service Requests . Extensible ServiceRequest.category = transportation-insecurity
Utility Insecurity Service Requests . Extensible ServiceRequest.category = utility-insecurity
Veteran Status Service Requests . Extensible ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required ServiceRequest.category = sdoh-category-unspecified
... Slices for orderDetail 0..* CodeableConcept Additional order information
Slice: Unordered, Open by value:coding
.... orderDetail:SubjectContactDetail S 0..1 CodeableConcept Additional order information
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
... subject 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
... occurrence[x] 0..1 When service should occur
.... occurrencePeriod Period
.... occurrenceDateTime dateTime
.... occurrenceTiming Timing
... requester 0..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
... reasonCode 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
... 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
... specimen 0..0
... bodySite 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.category:SDOHCCrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
from this IG
ServiceRequest.coderequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile(7.0.0) A request for a service to address an SDOH condition, observation or goal.
prr-1: orderDetail SHALL only be present if code is present
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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
..... 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: US Core ServiceRequest Category Codes (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
Digital Access Service Requests . Extensible ServiceRequest.category = digital-access
Digital Literacy Service Requests . Extensible ServiceRequest.category = digital-literacy
Less Than High School Education Service Requests . Extensible ServiceRequest.category = educational-attainment
Elder Abuse Service Requests . Extensible ServiceRequest.category = elder-abuse
Unemployment Service Requests . Extensible ServiceRequest.category = employment-status
Financial Insecurity Service Requests . Extensible ServiceRequest.category = financial-insecurity
Food Insecurity Service Requests . Extensible ServiceRequest.category = food-insecurity
Health Insurance Coverage Status Service Requests . Extensible ServiceRequest.category = health-insurance-coverage-status
Homelessness Service Requests . Extensible ServiceRequest.category = homelessness
Housing Instability Service Requests . Extensible ServiceRequest.category = housing-instability
Inadequate Housing Service Requests . Extensible ServiceRequest.category = inadequate-housing
VSAC 2.16.840.1.113762.1.4.1247.261 . Extensible ServiceRequest.category = incarceration-status
Intimate Partner Violence Service Requests . Extensible ServiceRequest.category = intimate-partner-violence
VSAC 2.16.840.1.113762.1.4.1247.269 . Extensible ServiceRequest.category = language-access
Material Hardship Service Requests . Extensible ServiceRequest.category = material-hardship
Medical Cost Burden Service Requests . Extensible ServiceRequest.category = medical-cost-burden
Health Literacy Service Requests . Extensible ServiceRequest.category = personal-health-literacy
Social Connection Service Requests . Extensible ServiceRequest.category = social-connection
Stress Service Requests . Extensible ServiceRequest.category = stress
Transportation Insecurity Service Requests . Extensible ServiceRequest.category = transportation-insecurity
Utility Insecurity Service Requests . Extensible ServiceRequest.category = utility-insecurity
Veteran Status Service Requests . Extensible ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required 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Σ 0..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Σ 0..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 (example): A location type where services are delivered.


... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode Σ 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... 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

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.category:SDOHCCrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.orderDetail:SubjectContactDetailexamplePattern: contacting-subject-prohibited
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from USCoreServiceRequestProfile

Summary

Mandatory: 2 elements
Must-Support: 9 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.basedOn
  • The element 1 is sliced based on the value of ServiceRequest.orderDetail
  • The element 1 is sliced based on the value of ServiceRequest.reasonReference
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile(7.0.0) A request for a service to address an SDOH condition, observation or goal.
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:pertainsToGoal S 0..* (Complex) Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... basedOn:SupportedBasedOn SΣ 0..* Reference(SDOHCC ServiceRequest) What request fulfills
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ele-1: All FHIR elements must have a @value or children
.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


ele-1: All FHIR elements must have a @value or children
.... category:SDOHCC SΣ 1..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.


ele-1: All FHIR elements must have a @value or children
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.


ele-1: All FHIR elements must have a @value or children
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
Digital Access Service Requests . Extensible ServiceRequest.category = digital-access
Digital Literacy Service Requests . Extensible ServiceRequest.category = digital-literacy
Less Than High School Education Service Requests . Extensible ServiceRequest.category = educational-attainment
Elder Abuse Service Requests . Extensible ServiceRequest.category = elder-abuse
Unemployment Service Requests . Extensible ServiceRequest.category = employment-status
Financial Insecurity Service Requests . Extensible ServiceRequest.category = financial-insecurity
Food Insecurity Service Requests . Extensible ServiceRequest.category = food-insecurity
Health Insurance Coverage Status Service Requests . Extensible ServiceRequest.category = health-insurance-coverage-status
Homelessness Service Requests . Extensible ServiceRequest.category = homelessness
Housing Instability Service Requests . Extensible ServiceRequest.category = housing-instability
Inadequate Housing Service Requests . Extensible ServiceRequest.category = inadequate-housing
VSAC 2.16.840.1.113762.1.4.1247.261 . Extensible ServiceRequest.category = incarceration-status
Intimate Partner Violence Service Requests . Extensible ServiceRequest.category = intimate-partner-violence
VSAC 2.16.840.1.113762.1.4.1247.269 . Extensible ServiceRequest.category = language-access
Material Hardship Service Requests . Extensible ServiceRequest.category = material-hardship
Medical Cost Burden Service Requests . Extensible ServiceRequest.category = medical-cost-burden
Health Literacy Service Requests . Extensible ServiceRequest.category = personal-health-literacy
Social Connection Service Requests . Extensible ServiceRequest.category = social-connection
Stress Service Requests . Extensible ServiceRequest.category = stress
Transportation Insecurity Service Requests . Extensible ServiceRequest.category = transportation-insecurity
Utility Insecurity Service Requests . Extensible ServiceRequest.category = utility-insecurity
Veteran Status Service Requests . Extensible ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required ServiceRequest.category = sdoh-category-unspecified

ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
.... orderDetail:SubjectContactDetail SΣC 0..1 CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
... 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
ele-1: All FHIR elements must have a @value or children
... encounter SΣ 0..1 Reference(US Core Encounter Profile(7.0.0)) Encounter in which the request was created
ele-1: All FHIR elements must have a @value or children
... occurrence[x] SΣ 0..1 When service should occur
ele-1: All FHIR elements must have a @value or children
.... occurrencePeriod Period
.... occurrenceDateTime dateTime
... authoredOn SΣ 0..1 dateTime Date request signed
ele-1: All FHIR elements must have a @value or children
... requester SΣ 0..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
ele-1: All FHIR elements must have a @value or children
... 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
ele-1: All FHIR elements must have a @value or children
... reasonCode Σ 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
ele-1: All FHIR elements must have a @value or children
... Slices for reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... reasonReference:SupportedReasonReference SΣ 0..* Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
ele-1: All FHIR elements must have a @value or children
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:SupportedSupportingInfo S 0..* Reference(SDOHCC Consent) Additional clinical information
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.category:SDOHCCrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.orderDetail:SubjectContactDetailexamplePattern: contacting-subject-prohibited
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Differential View

This structure is derived from USCoreServiceRequestProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* USCoreServiceRequestProfile(7.0.0) A request for a service to address an SDOH condition, observation or goal.
... 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
..... value[x] S 1..1 Reference(SDOHCC Goal) Value of extension
... 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 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... category 1..* CodeableConcept Classification of service
... Slices for category Content/Rules for all slices
.... 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
... code 1..1 CodeableConcept What is being requested/ordered
Binding: USCoreProcedureCodes (7.0.0) (required)
Additional BindingsPurposeUsage
Digital Access Service Requests . Extensible ServiceRequest.category = digital-access
Digital Literacy Service Requests . Extensible ServiceRequest.category = digital-literacy
Less Than High School Education Service Requests . Extensible ServiceRequest.category = educational-attainment
Elder Abuse Service Requests . Extensible ServiceRequest.category = elder-abuse
Unemployment Service Requests . Extensible ServiceRequest.category = employment-status
Financial Insecurity Service Requests . Extensible ServiceRequest.category = financial-insecurity
Food Insecurity Service Requests . Extensible ServiceRequest.category = food-insecurity
Health Insurance Coverage Status Service Requests . Extensible ServiceRequest.category = health-insurance-coverage-status
Homelessness Service Requests . Extensible ServiceRequest.category = homelessness
Housing Instability Service Requests . Extensible ServiceRequest.category = housing-instability
Inadequate Housing Service Requests . Extensible ServiceRequest.category = inadequate-housing
VSAC 2.16.840.1.113762.1.4.1247.261 . Extensible ServiceRequest.category = incarceration-status
Intimate Partner Violence Service Requests . Extensible ServiceRequest.category = intimate-partner-violence
VSAC 2.16.840.1.113762.1.4.1247.269 . Extensible ServiceRequest.category = language-access
Material Hardship Service Requests . Extensible ServiceRequest.category = material-hardship
Medical Cost Burden Service Requests . Extensible ServiceRequest.category = medical-cost-burden
Health Literacy Service Requests . Extensible ServiceRequest.category = personal-health-literacy
Social Connection Service Requests . Extensible ServiceRequest.category = social-connection
Stress Service Requests . Extensible ServiceRequest.category = stress
Transportation Insecurity Service Requests . Extensible ServiceRequest.category = transportation-insecurity
Utility Insecurity Service Requests . Extensible ServiceRequest.category = utility-insecurity
Veteran Status Service Requests . Extensible ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required ServiceRequest.category = sdoh-category-unspecified
... Slices for orderDetail 0..* CodeableConcept Additional order information
Slice: Unordered, Open by value:coding
.... orderDetail:SubjectContactDetail S 0..1 CodeableConcept Additional order information
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: contacting-subject-prohibited
... subject 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
... occurrence[x] 0..1 When service should occur
.... occurrencePeriod Period
.... occurrenceDateTime dateTime
.... occurrenceTiming Timing
... requester 0..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
... reasonCode 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
... 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
... specimen 0..0
... bodySite 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.category:SDOHCCrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
from this IG
ServiceRequest.coderequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile(7.0.0) A request for a service to address an SDOH condition, observation or goal.
prr-1: orderDetail SHALL only be present if code is present
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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
..... 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: US Core ServiceRequest Category Codes (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
Digital Access Service Requests . Extensible ServiceRequest.category = digital-access
Digital Literacy Service Requests . Extensible ServiceRequest.category = digital-literacy
Less Than High School Education Service Requests . Extensible ServiceRequest.category = educational-attainment
Elder Abuse Service Requests . Extensible ServiceRequest.category = elder-abuse
Unemployment Service Requests . Extensible ServiceRequest.category = employment-status
Financial Insecurity Service Requests . Extensible ServiceRequest.category = financial-insecurity
Food Insecurity Service Requests . Extensible ServiceRequest.category = food-insecurity
Health Insurance Coverage Status Service Requests . Extensible ServiceRequest.category = health-insurance-coverage-status
Homelessness Service Requests . Extensible ServiceRequest.category = homelessness
Housing Instability Service Requests . Extensible ServiceRequest.category = housing-instability
Inadequate Housing Service Requests . Extensible ServiceRequest.category = inadequate-housing
VSAC 2.16.840.1.113762.1.4.1247.261 . Extensible ServiceRequest.category = incarceration-status
Intimate Partner Violence Service Requests . Extensible ServiceRequest.category = intimate-partner-violence
VSAC 2.16.840.1.113762.1.4.1247.269 . Extensible ServiceRequest.category = language-access
Material Hardship Service Requests . Extensible ServiceRequest.category = material-hardship
Medical Cost Burden Service Requests . Extensible ServiceRequest.category = medical-cost-burden
Health Literacy Service Requests . Extensible ServiceRequest.category = personal-health-literacy
Social Connection Service Requests . Extensible ServiceRequest.category = social-connection
Stress Service Requests . Extensible ServiceRequest.category = stress
Transportation Insecurity Service Requests . Extensible ServiceRequest.category = transportation-insecurity
Utility Insecurity Service Requests . Extensible ServiceRequest.category = utility-insecurity
Veteran Status Service Requests . Extensible ServiceRequest.category = veteran-status
USCoreProcedureCodes (7.0.0) Required 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Σ 0..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Σ 0..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 (example): A location type where services are delivered.


... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode Σ 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... 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

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.category:SDOHCCrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.orderDetail:SubjectContactDetailexamplePattern: contacting-subject-prohibited
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from USCoreServiceRequestProfile

Summary

Mandatory: 2 elements
Must-Support: 9 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.basedOn
  • The element 1 is sliced based on the value of ServiceRequest.orderDetail
  • The element 1 is sliced based on the value of ServiceRequest.reasonReference
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron