SDOH Clinical Care
2.0.0 - STU 2
US
SDOH Clinical Care
2.0.0 - STU 2
US
This page is part of the SDOH Clinical Care for Multiple Domains (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ServiceRequest | Version: 2.0.0 | |||
| Draft as of 2020-12-14 | Computable Name: SDOHCCServiceRequest | |||
Profile for service requests that address Social Determinants of Health.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | ServiceRequest | 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 | |
  pertainsToGoal | S | 0..* | Reference(Goal) | 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 | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| Slices for category | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this | |
| category:SDOH | S | 0..* | 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 | 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 | 0..* | CodeableConcept | Additional order information Slice: Unordered, Open by pattern: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 | S | 1..1 | Reference(Group | US Core Patient Profile | US Core Location Profile) | Individual or Entity the service is ordered for |
| occurrence[x] | S | 0..1 | dateTime, Period, Timing | When service should occur |
| authoredOn | S | 0..1 | dateTime | Date request signed |
| requester | S | 0..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 |
| reasonCode | 0..* | CodeableConcept | Explanation/Justification for procedure or service | |
| 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 |
| specimen | 0..0 | |||
| bodySite | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategory |
| ServiceRequest.code | required | USCoreProcedureCodes |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to address an SDOH condition, observation or goal. |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| pertainsToGoal | S | 0..* | Reference(Goal) | 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 | Σ | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:SDOH | SΣ | 0..* | 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 |
| 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 | US Core Location Profile) | Individual or Entity the service is ordered for |
 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Σ | 0..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 |
| 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 |
 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 | ||||
| Path | Conformance | ValueSet / Code |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | RequestIntent |
| ServiceRequest.category | example | ServiceRequestCategoryCodes |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategory |
| ServiceRequest.priority | required | RequestPriority |
| ServiceRequest.code | required | USCoreProcedureCodes |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern: contacting-subject-prohibited |
| ServiceRequest.reasonCode | example | ProcedureReasonCodes |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to address an SDOH condition, observation or goal. | ||||
| 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.
| |||||
| 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 | |||||
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| id | 0..1 | string | 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 | Σ | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:SDOH | SΣ | 0..* | 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 | id | 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 | id | 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 | Σ | 0..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Σ | 0..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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | RequestIntent | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategory | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | required | USCoreProcedureCodes | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern: contacting-subject-prohibited | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| ServiceRequest.performerType | example | ParticipantRoles | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from ServiceRequest
Summary
Mandatory: 1 element
Must-Support: 16 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:
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | 0..* | ServiceRequest | 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 | |
| pertainsToGoal | S | 0..* | Reference(Goal) | 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 | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| Slices for category | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this | |
| category:SDOH | S | 0..* | 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 | 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 | 0..* | CodeableConcept | Additional order information Slice: Unordered, Open by pattern: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 | S | 1..1 | Reference(Group | US Core Patient Profile | US Core Location Profile) | Individual or Entity the service is ordered for |
| occurrence[x] | S | 0..1 | dateTime, Period, Timing | When service should occur |
| authoredOn | S | 0..1 | dateTime | Date request signed |
| requester | S | 0..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 |
| reasonCode | 0..* | CodeableConcept | Explanation/Justification for procedure or service | |
| 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 |
| specimen | 0..0 | |||
| bodySite | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategory |
| ServiceRequest.code | required | USCoreProcedureCodes |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to address an SDOH condition, observation or goal. |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| pertainsToGoal | S | 0..* | Reference(Goal) | 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 | Σ | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:SDOH | SΣ | 0..* | 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 |
| 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 | US Core Location Profile) | Individual or Entity the service is ordered for |
| 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Σ | 0..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 |
| 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 |
| 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 | ||||
| Path | Conformance | ValueSet / Code |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | RequestIntent |
| ServiceRequest.category | example | ServiceRequestCategoryCodes |
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategory |
| ServiceRequest.priority | required | RequestPriority |
| ServiceRequest.code | required | USCoreProcedureCodes |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern: contacting-subject-prohibited |
| ServiceRequest.reasonCode | example | ProcedureReasonCodes |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to address an SDOH condition, observation or goal. | ||||
| 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.
| |||||
| 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 | |||||
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| id | 0..1 | string | 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 | Σ | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:SDOH | SΣ | 0..* | 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 | id | 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 | id | 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 | Σ | 0..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Σ | 0..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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | RequestIntent | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.category:SDOH | required | SDOHCCValueSetSDOHCategory | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | required | USCoreProcedureCodes | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.orderDetail:SubjectContactDetail | example | Pattern: contacting-subject-prohibited | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| ServiceRequest.performerType | example | ParticipantRoles | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from ServiceRequest
Summary
Mandatory: 1 element
Must-Support: 16 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:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.sdoh-clinicalcare#2.0.0 based on FHIR 4.0.1. Generated 2022-11-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change