SHINNYHRSN - Local Development build (v1.6.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: SHINNY SDOH Service Request
| Official URL: http://shinny.org/us/ny/hrsn/StructureDefinition/SHINNYSDOHServiceRequest | Version: 1.6.3 | |||
| Active as of 2025-10-01 | 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:
- Examples for this Profile: ServiceRequest/ServiceRequestActiveExample and ServiceRequest/ServiceRequestCompleteExample
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
| 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) | |
  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 | |||
| 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 |
Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:SDOH |
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: US Core Procedure Codes (required): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. |
| Slices for orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Slice: Unordered, Open by pattern: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 | US Core Location Profile) | Individual or Entity the service is ordered for |
| encounter |
SΣ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
 occurrence[x] |
SΣ | 0..1 | When service should occur | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed |
| requester |
SΣ | 1..1 | Reference(RelatedPerson | Device | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who/what is requesting service |
| performer |
SΣ | 0..* | Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer |
| Slices for reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference |
SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Explanation/Justification for service or 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 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | |
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern Value: contacting-subject-prohibitedhttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from SDOHCCServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| language |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
| category |
1..* | CodeableConcept | Classification of service | |
| Slices for category |
Content/Rules for all slices | |||
| category:SDOH |
1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity | |
| encounter |
S | 1..1 | Reference(Encounter) | Encounter in which the request was created |
| requester |
1..1 | Reference(RelatedPerson | Device | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who/what is requesting service | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| ServiceRequest.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| 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 | |||
| 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 |
Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:SDOH |
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: US Core Procedure Codes (required): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. |
| Slices for orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Slice: Unordered, Open by pattern: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 | US Core Location Profile) | Individual or Entity the service is ordered for |
| encounter |
SΣ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
| occurrence[x] |
SΣ | 0..1 | When service should occur | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| 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(RelatedPerson | Device | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who/what is requesting service |
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| performer |
SΣ | 0..* | Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | 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: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| Slices for reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference |
SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Explanation/Justification for service or 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 | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | |
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern Value: contacting-subject-prohibitedhttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | |
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonFrom the FHIR Standard | |
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-roleFrom the FHIR Standard | |
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from SDOHCCServiceRequest
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| 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) | |
| 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 | |||
| 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 |
Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:SDOH |
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: US Core Procedure Codes (required): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. |
| Slices for orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Slice: Unordered, Open by pattern: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 | US Core Location Profile) | Individual or Entity the service is ordered for |
| encounter |
SΣ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
| occurrence[x] |
SΣ | 0..1 | When service should occur | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed |
| requester |
SΣ | 1..1 | Reference(RelatedPerson | Device | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who/what is requesting service |
| performer |
SΣ | 0..* | Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Requested performer |
| Slices for reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference |
SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Explanation/Justification for service or 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 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | |
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern Value: contacting-subject-prohibitedhttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Differential View
This structure is derived from SDOHCCServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| language |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
| category |
1..* | CodeableConcept | Classification of service | |
| Slices for category |
Content/Rules for all slices | |||
| category:SDOH |
1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity | |
| encounter |
S | 1..1 | Reference(Encounter) | Encounter in which the request was created |
| requester |
1..1 | Reference(RelatedPerson | Device | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who/what is requesting service | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| ServiceRequest.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| 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 | |||
| 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 |
Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:SDOH |
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: US Core Procedure Codes (required): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. |
| Slices for orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Slice: Unordered, Open by pattern: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 | US Core Location Profile) | Individual or Entity the service is ordered for |
| encounter |
SΣ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
| occurrence[x] |
SΣ | 0..1 | When service should occur | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| 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(RelatedPerson | Device | US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who/what is requesting service |
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| performer |
SΣ | 0..* | Reference(HealthcareService | Device | RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | 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: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| Slices for reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference |
SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Explanation/Justification for service or 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 | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | |
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern Value: contacting-subject-prohibitedhttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | |
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonFrom the FHIR Standard | |
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-roleFrom the FHIR Standard | |
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from SDOHCCServiceRequest
Other representations of profile: CSV, Excel, Schematron