CardX Hypertension Management Use Case
0.1.0 - ci-build
CardX Hypertension Management Use Case
0.1.0 - ci-build
CardX Hypertension Management Use Case, published by Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/cardx-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/min-blood-pressure-panel | Version: 0.1.0 | |||
| Draft as of 2023-08-03 | Computable Name: MinimumBloodPressurePanel | |||
The lowest measured systolic and diastolic blood pressures measured during a given time frame.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | Measurements and simple assertions | |
  status | S | 1..1 | code | registered | preliminary | final | amended + |
 subject | S | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| effective[x] | S | 1..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
| value[x] | 0..0 | |||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible) | |
  Slices for component | S | 2..* | BackboneElement | Blood pressure components Slice: Unordered, Open by pattern:code |
   component:MinSystolicBP | 1..1 | BackboneElement | Component results | |
  code | ||||
 coding | ||||
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
 code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314438006 |
  value[x] | S | 0..1 | Quantity | Actual component result |
| value | S | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | S | 1..1 | string | Unit representation |
| system | S | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | S | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
 component:MinDiastolicBP | 1..1 | BackboneElement | Component results | |
| code | ||||
| coding | ||||
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314451001 |
| value[x] | S | 0..1 | Quantity | Actual component result |
| value | S | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | S | 1..1 | string | Unit representation |
| system | S | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | S | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.interpretation | extensible | NumericResultInterpretationNom |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| subject | SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
  effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |
 effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible) | |
| Slices for component | SΣ | 2..* | BackboneElement | Blood pressure components Slice: Unordered, Open by pattern:code |
| component:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:MinSystolicBP | Σ | 1..1 | BackboneElement | Component results |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314438006 |
| value[x] | SΣ | 0..1 | Quantity | Actual component result |
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit | SΣ | 1..1 | string | Unit representation |
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| component:MinDiastolicBP | Σ | 1..1 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314451001 |
| value[x] | SΣ | 0..1 | Quantity | Actual component result |
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit | SΣ | 1..1 | string | Unit representation |
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.interpretation | extensible | NumericResultInterpretationNom |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:MinSystolicBP.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:MinSystolicBP.value[x].comparator | required | QuantityComparator |
| Observation.component:MinDiastolicBP.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:MinDiastolicBP.value[x].comparator | required | QuantityComparator |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | 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 | 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | 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() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
| 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 | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| subject | SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effectiveTiming | Timing | |||||||
| effectiveInstant | instant | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible) | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| 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 | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component | SΣ | 2..* | BackboneElement | Blood pressure components Slice: Unordered, Open by pattern:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:MinSystolicBP | Σ | 1..1 | BackboneElement | Component results | ||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314438006 | ||||
| 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 | ||||
| value[x] | SΣ | 0..1 | Quantity | Actual component result | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | SΣ | 1..1 | string | Unit representation | ||||
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
 referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:MinDiastolicBP | Σ | 1..1 | BackboneElement | Component results | ||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314451001 | ||||
| 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 | ||||
| value[x] | SΣ | 0..1 | Quantity | Actual component result | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | SΣ | 1..1 | string | Unit representation | ||||
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | NumericResultInterpretationNom | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:MinSystolicBP.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component:MinSystolicBP.value[x].comparator | required | QuantityComparator | ||||
| Observation.component:MinSystolicBP.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:MinSystolicBP.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:MinDiastolicBP.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component:MinDiastolicBP.value[x].comparator | required | QuantityComparator | ||||
| Observation.component:MinDiastolicBP.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:MinDiastolicBP.interpretation | extensible | ObservationInterpretationCodes |
| 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() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |
This structure is derived from Observation
Summary
Mandatory: 4 elements (12 nested mandatory elements)
Must-Support: 18 elements
Fixed Value: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Observation | Measurements and simple assertions | |
| status | S | 1..1 | code | registered | preliminary | final | amended + |
| subject | S | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| effective[x] | S | 1..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
| value[x] | 0..0 | |||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible) | |
| Slices for component | S | 2..* | BackboneElement | Blood pressure components Slice: Unordered, Open by pattern:code |
| component:MinSystolicBP | 1..1 | BackboneElement | Component results | |
| code | ||||
| coding | ||||
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314438006 |
| value[x] | S | 0..1 | Quantity | Actual component result |
| value | S | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | S | 1..1 | string | Unit representation |
| system | S | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | S | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| component:MinDiastolicBP | 1..1 | BackboneElement | Component results | |
| code | ||||
| coding | ||||
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314451001 |
| value[x] | S | 0..1 | Quantity | Actual component result |
| value | S | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | S | 1..1 | string | Unit representation |
| system | S | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | S | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.interpretation | extensible | NumericResultInterpretationNom |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| subject | SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible) | |
| Slices for component | SΣ | 2..* | BackboneElement | Blood pressure components Slice: Unordered, Open by pattern:code |
| component:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:MinSystolicBP | Σ | 1..1 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314438006 |
| value[x] | SΣ | 0..1 | Quantity | Actual component result |
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit | SΣ | 1..1 | string | Unit representation |
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| component:MinDiastolicBP | Σ | 1..1 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314451001 |
| value[x] | SΣ | 0..1 | Quantity | Actual component result |
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit | SΣ | 1..1 | string | Unit representation |
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.interpretation | extensible | NumericResultInterpretationNom |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:MinSystolicBP.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:MinSystolicBP.value[x].comparator | required | QuantityComparator |
| Observation.component:MinDiastolicBP.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:MinDiastolicBP.value[x].comparator | required | QuantityComparator |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | 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 | 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | 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() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
| 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 | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| subject | SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effectiveTiming | Timing | |||||||
| effectiveInstant | instant | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible) | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| 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 | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component | SΣ | 2..* | BackboneElement | Blood pressure components Slice: Unordered, Open by pattern:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:MinSystolicBP | Σ | 1..1 | BackboneElement | Component results | ||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314438006 | ||||
| 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 | ||||
| value[x] | SΣ | 0..1 | Quantity | Actual component result | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | SΣ | 1..1 | string | Unit representation | ||||
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:MinDiastolicBP | Σ | 1..1 | BackboneElement | Component results | ||||
| 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 | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 314451001 | ||||
| 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 | ||||
| value[x] | SΣ | 0..1 | Quantity | Actual component result | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | SΣ | 1..1 | string | Unit representation | ||||
| system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
| code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | NumericResultInterpretationNom | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:MinSystolicBP.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component:MinSystolicBP.value[x].comparator | required | QuantityComparator | ||||
| Observation.component:MinSystolicBP.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:MinSystolicBP.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:MinDiastolicBP.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component:MinDiastolicBP.value[x].comparator | required | QuantityComparator | ||||
| Observation.component:MinDiastolicBP.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:MinDiastolicBP.interpretation | extensible | ObservationInterpretationCodes |
| 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() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |
This structure is derived from Observation
Summary
Mandatory: 4 elements (12 nested mandatory elements)
Must-Support: 18 elements
Fixed Value: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Clinical Interoperability Council. Package hl7.fhir.us.cardx-htn#0.1.0 based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change