The official URL for this profile is:
http://standardhealthrecord.org/fhir/StructureDefinition/shr-behavior-SubstanceUse
Assertion concerning the past or current use of a substance (alcohol, recreational drugs, illegal drugs, or abuse of prescription medication) that could negatively impact the subject's health.
This profile builds on Observation.
This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
SHR Mapping Source
This structure represents the following SHR mapping definition:
shr.behavior.SubstanceUse maps to Observation: _Entry.CreationTime maps to issued RelatedEncounter maps to context Subject maps to subject Category maps to category ClinicallyRelevantTime maps to effective[x] FindingMethod maps to method FindingStatus maps to status CodeableConcept maps to value[x] ValueAbsentReason maps to dataAbsentReason ObservationCode maps to code BodySite maps to bodySite Specimen maps to specimen Device maps to device Interpretation maps to interpretation Details maps to comment ReferenceRange maps to referenceRange ReferenceRange.Range.LowerBound maps to referenceRange.low ReferenceRange.Range.UpperBound maps to referenceRange.high ReferenceRange.Type maps to referenceRange.type ReferenceRange.ApplicableSubpopulation maps to referenceRange.appliesTo ReferenceRange.ApplicableAgeRange maps to referenceRange.age fix related.type to #has-member ObservationComponent maps to component (slice on = coding.code; slice strategy = includes) ObservationComponent.ObservationCode maps to component.code ObservationComponent.Quantity maps to component.value[x] ObservationComponent.CodeableConcept maps to component.value[x] ObservationComponent.string maps to component.value[x] ObservationComponent.Range maps to component.value[x] ObservationComponent.Ratio maps to component.value[x] ObservationComponent.Attachment maps to component.value[x] ObservationComponent.time maps to component.value[x] ObservationComponent.dateTime maps to component.value[x] ObservationComponent.TimePeriod maps to component.value[x] ObservationComponent.IntegerQuantity maps to component.value[x] ObservationComponent.ValueAbsentReason maps to component.dataAbsentReason ObservationComponent.Interpretation maps to component.interpretation ObservationComponent.ReferenceRange maps to component.referenceRange Members.Observation maps to related.target (slice at = related; slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes)
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | SHR SubstanceUse Profile obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR Author Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR Informant Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension | |
![]() ![]() ![]() | 0..1 | CodeableConcept | SHR FocalSubject Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-FocalSubject-extension | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR FocalSubjectReference Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-FocalSubjectReference-extension | |
![]() ![]() ![]() | 0..* | (Complex) | SHR Evidence Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-Evidence-extension | |
![]() ![]() ![]() | 0..1 | CodeableConcept | SHR ChangeFlag Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-ChangeFlag-extension Binding: SHR ChangeFlagVS ValueSet (required) | |
![]() ![]() ![]() | 0..* | CodeableConcept | SHR ObservationQualifier Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-ObservationQualifier-extension | |
![]() ![]() ![]() | 0..* | (Complex) | SHR ReasonForBehavior Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-behavior-ReasonForBehavior-extension | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR ReadinessToChange Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-behavior-ReadinessToChange-extension | |
![]() ![]() ![]() | 0..* | (Complex) | SHR Outcome Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan), Reference(DeviceRequest), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ProcedureRequest), Reference(ReferralRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
![]() ![]() ![]() | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding Binding: Observation Category Codes (extensible) | ||
![]() ![]() ![]() | 1..1 | CodeableConcept | ||
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ncimeta.nci.nih.gov |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: C024251 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | 1..1 | CodeableConcept | ||
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 54511-1 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() | Σ | 0..1 | Reference(SHR Patient Profile), Reference(SHR Group Profile), Reference(SHR Device Profile), Reference(SHR Geoposition Profile) | Who and/or what this is about |
![]() ![]() ![]() | 0..1 | Reference(SHR EncounterPerformed Profile) | Healthcare event during which this observation is made | |
![]() ![]() ![]() | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
![]() ![]() ![]() | Σ | 1..1 | instant | Date/Time this was made available |
![]() ![]() ![]() | Σ | 0..* | Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Actual result Binding: SHR SubstanceOfAbuseVS ValueSet (required) |
![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() | 0..1 | string | Comments about result | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Observed body part Binding: SHR BodySiteVS ValueSet (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
![]() ![]() ![]() | ΣI | 0..* | BackboneElement | Resource related to this observation |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) Fixed Value: has-member | |
![]() ![]() ![]() ![]() | 1..1 | Reference(SHR QuestionAnswer Profile) | Resource that is related to this one | |
![]() ![]() ![]() | ΣI | BackboneElement | Component results Slice: Unordered, Open by value:coding.code | |
![]() ![]() ![]() | ΣI | 0..1 | BackboneElement | FrequencyOfUse |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Actual component result Binding: SHR SemiquantitativeFrequencyVS ValueSet (example) |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() | ΣI | 0..1 | BackboneElement | ExposureRoute |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Actual component result Binding: SNOMED CT Route Codes (required) |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() | ΣI | 0..1 | BackboneElement | ExposureMethod |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Actual component result |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() | ΣI | 0..* | BackboneElement | ExposureAmount |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | SHR Ratio Profile | Actual component result |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() |
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
SHR Mapping Source
This structure represents the following SHR mapping definition:
shr.behavior.SubstanceUse maps to Observation: _Entry.CreationTime maps to issued RelatedEncounter maps to context Subject maps to subject Category maps to category ClinicallyRelevantTime maps to effective[x] FindingMethod maps to method FindingStatus maps to status CodeableConcept maps to value[x] ValueAbsentReason maps to dataAbsentReason ObservationCode maps to code BodySite maps to bodySite Specimen maps to specimen Device maps to device Interpretation maps to interpretation Details maps to comment ReferenceRange maps to referenceRange ReferenceRange.Range.LowerBound maps to referenceRange.low ReferenceRange.Range.UpperBound maps to referenceRange.high ReferenceRange.Type maps to referenceRange.type ReferenceRange.ApplicableSubpopulation maps to referenceRange.appliesTo ReferenceRange.ApplicableAgeRange maps to referenceRange.age fix related.type to #has-member ObservationComponent maps to component (slice on = coding.code; slice strategy = includes) ObservationComponent.ObservationCode maps to component.code ObservationComponent.Quantity maps to component.value[x] ObservationComponent.CodeableConcept maps to component.value[x] ObservationComponent.string maps to component.value[x] ObservationComponent.Range maps to component.value[x] ObservationComponent.Ratio maps to component.value[x] ObservationComponent.Attachment maps to component.value[x] ObservationComponent.time maps to component.value[x] ObservationComponent.dateTime maps to component.value[x] ObservationComponent.TimePeriod maps to component.value[x] ObservationComponent.IntegerQuantity maps to component.value[x] ObservationComponent.ValueAbsentReason maps to component.dataAbsentReason ObservationComponent.Interpretation maps to component.interpretation ObservationComponent.ReferenceRange maps to component.referenceRange Members.Observation maps to related.target (slice at = related; slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes)
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | SHR SubstanceUse Profile obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR Author Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR Informant Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension | |
![]() ![]() ![]() | 0..1 | CodeableConcept | SHR FocalSubject Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-FocalSubject-extension | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR FocalSubjectReference Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-FocalSubjectReference-extension | |
![]() ![]() ![]() | 0..* | (Complex) | SHR Evidence Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-Evidence-extension | |
![]() ![]() ![]() | 0..1 | CodeableConcept | SHR ChangeFlag Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-ChangeFlag-extension Binding: SHR ChangeFlagVS ValueSet (required) | |
![]() ![]() ![]() | 0..* | CodeableConcept | SHR ObservationQualifier Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-finding-ObservationQualifier-extension | |
![]() ![]() ![]() | 0..* | (Complex) | SHR ReasonForBehavior Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-behavior-ReasonForBehavior-extension | |
![]() ![]() ![]() | 0..1 | (Complex) | SHR ReadinessToChange Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-behavior-ReadinessToChange-extension | |
![]() ![]() ![]() | 0..* | (Complex) | SHR Outcome Extension URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan), Reference(DeviceRequest), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ProcedureRequest), Reference(ReferralRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
![]() ![]() ![]() | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding Binding: Observation Category Codes (extensible) | ||
![]() ![]() ![]() | 1..1 | CodeableConcept | ||
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://ncimeta.nci.nih.gov |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: C024251 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | 1..1 | CodeableConcept | ||
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 54511-1 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() | Σ | 0..1 | Reference(SHR Patient Profile), Reference(SHR Group Profile), Reference(SHR Device Profile), Reference(SHR Geoposition Profile) | Who and/or what this is about |
![]() ![]() ![]() | 0..1 | Reference(SHR EncounterPerformed Profile) | Healthcare event during which this observation is made | |
![]() ![]() ![]() | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
![]() ![]() ![]() | Σ | 1..1 | instant | Date/Time this was made available |
![]() ![]() ![]() | Σ | 0..* | Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Actual result Binding: SHR SubstanceOfAbuseVS ValueSet (required) |
![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() | 0..1 | string | Comments about result | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Observed body part Binding: SHR BodySiteVS ValueSet (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
![]() ![]() ![]() | ΣI | 0..* | BackboneElement | Resource related to this observation |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) Fixed Value: has-member | |
![]() ![]() ![]() ![]() | 1..1 | Reference(SHR QuestionAnswer Profile) | Resource that is related to this one | |
![]() ![]() ![]() | ΣI | BackboneElement | Component results Slice: Unordered, Open by value:coding.code | |
![]() ![]() ![]() | ΣI | 0..1 | BackboneElement | FrequencyOfUse |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Actual component result Binding: SHR SemiquantitativeFrequencyVS ValueSet (example) |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() | ΣI | 0..1 | BackboneElement | ExposureRoute |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Actual component result Binding: SNOMED CT Route Codes (required) |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() | ΣI | 0..1 | BackboneElement | ExposureMethod |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Actual component result |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() | ΣI | 0..* | BackboneElement | ExposureAmount |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | SHR Ratio Profile | Actual component result |
![]() ![]() ![]() ![]() | I | 0..1 | CodeableConcept | Why the component result is missing Binding: SHR ValueAbsentReasonVS ValueSet (required) |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (required) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | Provides guide for interpretation of component result | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() ![]() | I | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Text based reference range in an observation | |
![]() |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Name | Conformance | ValueSet |
Observation.language | Common Languages | extensible | Common Languages |
Observation.status | ObservationStatus | required | ObservationStatus |
Observation.category | Observation Category Codes | extensible | Observation Category Codes |
Observation.code | LOINC Codes | example | LOINC Codes |
Observation.valueCodeableConcept | SHR SubstanceOfAbuseVS ValueSet | required | SHR SubstanceOfAbuseVS ValueSet |
Observation.dataAbsentReason | SHR ValueAbsentReasonVS ValueSet | required | SHR ValueAbsentReasonVS ValueSet |
Observation.interpretation | Observation Interpretation Codes | required | Observation Interpretation Codes |
Observation.bodySite | SHR BodySiteVS ValueSet | required | SHR BodySiteVS ValueSet |
Observation.method | Observation Methods | example | Observation Methods |
Observation.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | extensible | Observation Reference Range Applies To Codes |
Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.valueCodeableConcept | SNOMED CT Route Codes | required | SNOMED CT Route Codes |
Observation.component.dataAbsentReason | SHR ValueAbsentReasonVS ValueSet | required | SHR ValueAbsentReasonVS ValueSet |
Observation.component.interpretation | Observation Interpretation Codes | required | Observation Interpretation Codes |
Observation.component.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.component.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.valueCodeableConcept | SNOMED CT Route Codes | required | SNOMED CT Route Codes |
Observation.component.dataAbsentReason | SHR ValueAbsentReasonVS ValueSet | required | SHR ValueAbsentReasonVS ValueSet |
Observation.component.interpretation | Observation Interpretation Codes | required | Observation Interpretation Codes |
Observation.component.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.component.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | SHR ValueAbsentReasonVS ValueSet | required | SHR ValueAbsentReasonVS ValueSet |
Observation.component.interpretation | Observation Interpretation Codes | required | Observation Interpretation Codes |
Observation.component.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.component.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | SHR ValueAbsentReasonVS ValueSet | required | SHR ValueAbsentReasonVS ValueSet |
Observation.component.interpretation | Observation Interpretation Codes | required | Observation Interpretation Codes |
Observation.component.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.component.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
Id | Path | Details | Requirements |
dom-2 | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Observation | 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-3 | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
obs-7 | Observation | If code is the same as a component code then the value element associated with the code SHALL NOT be present : value.empty() or code!=component.code | |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
ele-1 | Observation.related | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |