SDOH Clinical Care
1.0.0 - STU 1
SDOH Clinical Care
1.0.0 - STU 1
This page is part of the SDOH Clinical Care for Multiple Domains (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure |
| Version: | 1.0.0 |
| Name: | SDOHCCProcedure |
| Title: | SDOHCC Procedure |
| Status: | Draft as of 2020-12-14T04:01:34+00:00 |
| Definition: | This profile constrains the Procedure resource for interventions that address Social Determinants of Health. |
| Publisher: | HL7 International - Patient Care WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreProcedureProfile
Summary
Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from USCoreProcedureProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Procedure | I | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. SDOH-Pro-1: An SDOH category SHOULD appear either in the .category element or in the category extension |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  extension-Procedure.category | SI | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category |
   url | 1..1 | uri | "http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category" | |
| resource-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 | S | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
 basedOn:SupportedBasedOn | S | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
| category | I | 0..1 | CodeableConcept | Classification of the procedure |
| code | 1..1 | CodeableConcept | Procedure codes from SNOMED CT Binding: ProcedureCodes(SNOMEDCT) (required): SNOMED CT codes describing the type of Procedure | |
 Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
  coding:CPTCoding | S | 0..* | Coding | Procedure codes from CPT Binding: All CPT codes (required): CPT codes describing the type of Procedure |
 system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.ama-assn.org/go/cpt |
| coding:LOINCCoding | S | 0..* | Coding | Procedure codes from LOINC Binding: LOINCCodes (required): LOINC codes describing the type of Procedure |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
 coding:HCPCSIICoding | S | 0..* | Coding | Procedure codes from HCPCS Level II Binding: SDOHCC ValueSet HCPCSII (required): HCPCS Level II codes describing the type of Procedure |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.6.285 | |
| reasonCode | 0..* | CodeableConcept | Coded reason procedure performed | |
| Slices for reasonReference | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() | |
| reasonReference:SupportedReasonReference | S | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. SDOH-Pro-1: An SDOH category SHOULD appear either in the .category element or in the category extension |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
| extension-Procedure.category | SI | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category" | |
  value[x] | 0..1 | Value of extension | ||
| valueBase64Binary | base64Binary | |||
| valueBoolean | boolean | |||
| valueCanonical | canonical(Any) | |||
| valueCode | code | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueDecimal | decimal | |||
| valueId | id | |||
| valueInstant | instant | |||
| valueInteger | integer | |||
| valueMarkdown | markdown | |||
| valueOid | oid | |||
| valuePositiveInt | positiveInt | |||
| valueString | string | |||
| valueTime | time | |||
| valueUnsignedInt | unsignedInt | |||
| valueUri | uri | |||
| valueUrl | url | |||
| valueUuid | uuid | |||
| valueAddress | Address | |||
| valueAge | Age | |||
| valueAnnotation | Annotation | |||
| valueAttachment | Attachment | |||
| valueCodeableConcept | CodeableConcept | |||
| valueCoding | Coding | |||
| valueContactPoint | ContactPoint | |||
| valueCount | Count | |||
| valueDistance | Distance | |||
| valueDuration | Duration | |||
| valueHumanName | HumanName | |||
| valueIdentifier | Identifier | |||
| valueMoney | Money | |||
| valuePeriod | Period | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueReference | Reference(Any) | |||
| valueSampledData | SampledData | |||
| valueSignature | Signature | |||
| valueTiming | Timing | |||
| valueContactDetail | ContactDetail | |||
| valueContributor | Contributor | |||
| valueDataRequirement | DataRequirement | |||
| valueExpression | Expression | |||
| valueParameterDefinition | ParameterDefinition | |||
| valueRelatedArtifact | RelatedArtifact | |||
| valueTriggerDefinition | TriggerDefinition | |||
| valueUsageContext | UsageContext | |||
| valueDosage | Dosage | |||
 valueMeta | Meta | |||
| resource-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 | |
| Slices for 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 | External Identifiers for this procedure |
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
| Slices for basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
| basedOn:SupportedBasedOn | SΣ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
| partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event |
| status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. |
| category | ΣI | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. |
| code | SΣ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT Binding: ProcedureCodes(SNOMEDCT) (required): SNOMED CT codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:CPTCoding | SΣ | 0..* | Coding | Procedure codes from CPT Binding: All CPT codes (required): CPT codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.ama-assn.org/go/cpt |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:LOINCCoding | SΣ | 0..* | Coding | Procedure codes from LOINC Binding: LOINCCodes (required): LOINC codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:HCPCSIICoding | SΣ | 0..* | Coding | Procedure codes from HCPCS Level II Binding: SDOHCC ValueSet HCPCSII (required): HCPCS Level II codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.6.285 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| 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(US Core Patient Profile) | Who the procedure was performed on |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| performed[x] | SΣ | 1..1 | When the procedure was performed | |
| performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure |
| performer | Σ | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. |
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |
| location | Σ | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. |
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
| bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. |
| report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |
| complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |
| note | 0..* | Annotation | Additional information about the procedure | |
| focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |
| manipulated | 1..1 | Reference(Device) | Device that was changed | |
| usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |
| usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. SDOH-Pro-1: An SDOH category SHOULD appear either in the .category element or in the category extension |
| extension-Procedure.category | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category |
| resource-pertainsToGoal | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | |
| value[x] | 1..1 | Reference(SDOHCC Goal) | Value of extension | |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
| basedOn:SupportedBasedOn | Σ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| code | Σ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT Binding: ProcedureCodes(SNOMEDCT) (required): SNOMED CT codes describing the type of Procedure |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:CPTCoding | Σ | 0..* | Coding | Procedure codes from CPT Binding: All CPT codes (required): CPT codes describing the type of Procedure |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.ama-assn.org/go/cpt |
| coding:LOINCCoding | Σ | 0..* | Coding | Procedure codes from LOINC Binding: LOINCCodes (required): LOINC codes describing the type of Procedure |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| coding:HCPCSIICoding | Σ | 0..* | Coding | Procedure codes from HCPCS Level II Binding: SDOHCC ValueSet HCPCSII (required): HCPCS Level II codes describing the type of Procedure |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on |
| performed[x] | Σ | 1..1 | When the procedure was performed | |
| performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| reasonReference:SupportedReasonReference | Σ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
| Documentation for this format | ||||
This structure is derived from USCoreProcedureProfile
Summary
Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 4 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 USCoreProcedureProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. SDOH-Pro-1: An SDOH category SHOULD appear either in the .category element or in the category extension |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension-Procedure.category | SI | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category |
| url | 1..1 | uri | "http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category" | |
| resource-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 | S | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
| basedOn:SupportedBasedOn | S | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
| category | I | 0..1 | CodeableConcept | Classification of the procedure |
| code | 1..1 | CodeableConcept | Procedure codes from SNOMED CT Binding: ProcedureCodes(SNOMEDCT) (required): SNOMED CT codes describing the type of Procedure | |
| Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:CPTCoding | S | 0..* | Coding | Procedure codes from CPT Binding: All CPT codes (required): CPT codes describing the type of Procedure |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.ama-assn.org/go/cpt |
| coding:LOINCCoding | S | 0..* | Coding | Procedure codes from LOINC Binding: LOINCCodes (required): LOINC codes describing the type of Procedure |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| coding:HCPCSIICoding | S | 0..* | Coding | Procedure codes from HCPCS Level II Binding: SDOHCC ValueSet HCPCSII (required): HCPCS Level II codes describing the type of Procedure |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.6.285 | |
| reasonCode | 0..* | CodeableConcept | Coded reason procedure performed | |
| Slices for reasonReference | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() | |
| reasonReference:SupportedReasonReference | S | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. SDOH-Pro-1: An SDOH category SHOULD appear either in the .category element or in the category extension |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
| extension-Procedure.category | SI | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category" | |
| value[x] | 0..1 | Value of extension | ||
| valueBase64Binary | base64Binary | |||
| valueBoolean | boolean | |||
| valueCanonical | canonical(Any) | |||
| valueCode | code | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueDecimal | decimal | |||
| valueId | id | |||
| valueInstant | instant | |||
| valueInteger | integer | |||
| valueMarkdown | markdown | |||
| valueOid | oid | |||
| valuePositiveInt | positiveInt | |||
| valueString | string | |||
| valueTime | time | |||
| valueUnsignedInt | unsignedInt | |||
| valueUri | uri | |||
| valueUrl | url | |||
| valueUuid | uuid | |||
| valueAddress | Address | |||
| valueAge | Age | |||
| valueAnnotation | Annotation | |||
| valueAttachment | Attachment | |||
| valueCodeableConcept | CodeableConcept | |||
| valueCoding | Coding | |||
| valueContactPoint | ContactPoint | |||
| valueCount | Count | |||
| valueDistance | Distance | |||
| valueDuration | Duration | |||
| valueHumanName | HumanName | |||
| valueIdentifier | Identifier | |||
| valueMoney | Money | |||
| valuePeriod | Period | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueReference | Reference(Any) | |||
| valueSampledData | SampledData | |||
| valueSignature | Signature | |||
| valueTiming | Timing | |||
| valueContactDetail | ContactDetail | |||
| valueContributor | Contributor | |||
| valueDataRequirement | DataRequirement | |||
| valueExpression | Expression | |||
| valueParameterDefinition | ParameterDefinition | |||
| valueRelatedArtifact | RelatedArtifact | |||
| valueTriggerDefinition | TriggerDefinition | |||
| valueUsageContext | UsageContext | |||
| valueDosage | Dosage | |||
| valueMeta | Meta | |||
| resource-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 | |
| Slices for 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 | External Identifiers for this procedure |
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
| Slices for basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
| basedOn:SupportedBasedOn | SΣ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
| partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event |
| status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. |
| category | ΣI | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. |
| code | SΣ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT Binding: ProcedureCodes(SNOMEDCT) (required): SNOMED CT codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:CPTCoding | SΣ | 0..* | Coding | Procedure codes from CPT Binding: All CPT codes (required): CPT codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.ama-assn.org/go/cpt |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:LOINCCoding | SΣ | 0..* | Coding | Procedure codes from LOINC Binding: LOINCCodes (required): LOINC codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:HCPCSIICoding | SΣ | 0..* | Coding | Procedure codes from HCPCS Level II Binding: SDOHCC ValueSet HCPCSII (required): HCPCS Level II codes describing the type of Procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.6.285 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| 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(US Core Patient Profile) | Who the procedure was performed on |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| performed[x] | SΣ | 1..1 | When the procedure was performed | |
| performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure |
| performer | Σ | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. |
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |
| location | Σ | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. |
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
| bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. |
| report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |
| complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |
| note | 0..* | Annotation | Additional information about the procedure | |
| focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |
| manipulated | 1..1 | Reference(Device) | Device that was changed | |
| usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |
| usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Procedure.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Procedure.status | required | EventStatus |
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT) |
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT) |
| Procedure.code | required | ProcedureCodes(SNOMEDCT) |
| Procedure.code.coding:CPTCoding | required | All CPT codes |
| Procedure.code.coding:LOINCCoding | required | LOINCCodes |
| Procedure.code.coding:HCPCSIICoding | required | SDOHCCValueSetHCPCSII |
| Procedure.performer.function | example | ProcedurePerformerRoleCodes |
| Procedure.reasonCode | example | ProcedureReasonCodes |
| Procedure.bodySite | example | SNOMEDCTBodyStructures |
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT) |
| Procedure.complication | example | Condition/Problem/DiagnosisCodes |
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT) |
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodes |
| Procedure.usedCode | example | FHIRDeviceTypes |
| Id | Path | Details | Requirements |
| dom-2 | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Procedure | 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 | Procedure | 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 | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
| SDOH-Pro-1 | Procedure | An SDOH category SHOULD appear either in the .category element or in the category extension : extension('http://hl7.org/fhir/4.5/StructureDefinition/extension-Procedure.category').where(value.memberOf('http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory')).exists() or category.where($this.memberOf ('http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory')).exists() | |
| ele-1 | Procedure.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.extension:CategorySDOH | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.extension:CategorySDOH | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.extension:CategorySDOH.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.extension:CategorySDOH.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.extension:CategorySDOH.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.extension:pertainsToGoal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.extension:pertainsToGoal | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.extension:pertainsToGoal.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.basedOn:SupportedBasedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.code.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:CPTCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:CPTCoding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.code.coding:CPTCoding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.code.coding:CPTCoding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:CPTCoding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:CPTCoding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:CPTCoding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:CPTCoding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:LOINCCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:LOINCCoding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.code.coding:LOINCCoding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.code.coding:LOINCCoding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:LOINCCoding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:LOINCCoding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:LOINCCoding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:LOINCCoding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:HCPCSIICoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:HCPCSIICoding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.code.coding:HCPCSIICoding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.code.coding:HCPCSIICoding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:HCPCSIICoding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:HCPCSIICoding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:HCPCSIICoding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.coding:HCPCSIICoding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.code.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.performed[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.recorder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.asserter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.performer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.performer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.performer.function | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.performer.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.performer.onBehalfOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.reasonReference:SupportedReasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.outcome | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.report | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.complication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.complicationDetail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.followUp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.focalDevice | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.focalDevice.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.focalDevice.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.focalDevice.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Procedure.focalDevice.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Procedure.focalDevice.action | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.focalDevice.manipulated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.usedReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Procedure.usedCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.sdoh-clinicalcare#1.0.0 based on FHIR 4.0.1. Generated 2021-08-05
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change