Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCIM HeartRate

Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-HeartRate Version: 1.3.15
Active as of 2024-04-09 Computable Name: Zib HeartRate

Copyright/Legal: CC0

This profile is derived from the HL7 Vital Signs profile for heart rate in order to add mappings from the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) Heartrate v3.1, release 2017, and to provide extensions for missing concepts.

Obtaining information on circulation and heart function by measuring the heartbeat.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Vital Signs HeartRate

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Vital Signs HeartRate HeartRate
... identifier 0..* Identifier Business Identifier for observation
... subject 1..1 Reference(nl-core-patient) Who and/or what this is about
... effective[x] 1..1 dateTime, Period HeartRateDateTime
... valueQuantity:valueQuantity 1..1 Quantity HeartRateValue
... interpretation 0..1 CodeableConcept HeartbeatRegularity
Binding: HartslagRegelmatigheidCodelijst (extensible): HartslagRegelmatigheidCodelijst

... comment 0..1 string Comment
... method 0..1 CodeableConcept HeartRateMeasurementMethod
Binding: HartslagMeetMethodeCodelijst (extensible): HartslagMeetMethodeCodelijst


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.interpretationextensibleHartslagRegelmatigheidCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20171231000000
from this IG
Observation.methodextensibleHartslagMeetMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20171231000000
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Vital Signs HeartRate HeartRate
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
vs-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... category SC 1..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


vs-4: Must have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ 1..1 CodeableConcept Heart Rate
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:HeartRateCode Σ 0..* Coding Code defined by a terminology system
... subject SΣ 1..1 Reference(nl-core-patient) Who and/or what this is about
... effective[x] SΣ 1..1 HeartRateDateTime
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 1..* Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient) Who is responsible for the observation
.... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... Slices for value[x] ΣC 0..1 Quantity Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity SΣC 1..1 Quantity HeartRateValue
Binding: Vital Signs Units (required): Common UCUM units for recording Vital Signs

..... 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 responses from the common UCUM units for vital signs value set.
Fixed Value: /min
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..1 CodeableConcept HeartbeatRegularity
Binding: HartslagRegelmatigheidCodelijst (extensible): HartslagRegelmatigheidCodelijst

... comment 0..1 string Comment
... method 0..1 CodeableConcept HeartRateMeasurementMethod
Binding: HartslagMeetMethodeCodelijst (extensible): HartslagMeetMethodeCodelijst

... related SΣ 0..* BackboneElement Used when reporting vital signs panel components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type S 1..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: has-member
.... target S 1..1 Reference(VitalSigns Profile NL) Resource that is related to this one
... component SΣC 0..* BackboneElement Component results
vs-3: If there is no a value a data absent reason must be present
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueAttachment Attachment
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservation Category Codes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.value[x]:valueQuantityrequiredVital Signs Units
http://hl7.org/fhir/ValueSet/ucum-vitals-common
from the FHIR Standard
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator
from the FHIR Standard
Observation.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard
Observation.interpretationextensibleHartslagRegelmatigheidCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20171231000000
from this IG
Observation.methodextensibleHartslagMeetMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20171231000000
from this IG
Observation.related.typerequiredFixed Value: has-member
http://hl7.org/fhir/ValueSet/observation-relationshiptypes
from the FHIR Standard
Observation.component.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
vs-2errorObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
vs-3errorObservation.componentIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()
vs-4errorObservation.categoryMust have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='vital-signs').exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Vital Signs HeartRate HeartRate
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
vs-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... 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: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 | ProcedureRequest | ReferralRequest) Fulfills plan, proposal or order
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category SC 1..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


vs-4: Must have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ 1..1 CodeableConcept Heart Rate
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:HeartRateCode Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..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
Fixed Value: 8867-4
...... 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(nl-core-patient) Who and/or what this is about
... context 0..1 Reference(nl-core-episodeofcare | HCIM Encounter | gp-Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 HeartRateDateTime
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this was made available
... performer SΣ 1..* Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient) Who is responsible for the observation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for value[x] ΣC 0..1 Quantity Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity SΣC 1..1 Quantity HeartRateValue
Binding: Vital Signs Units (required): Common UCUM units for recording Vital Signs

..... id 0..1 string xml:id (or equivalent in JSON)
..... 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 responses from the common UCUM units for vital signs value set.
Fixed Value: /min
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..1 CodeableConcept HeartbeatRegularity
Binding: HartslagRegelmatigheidCodelijst (extensible): HartslagRegelmatigheidCodelijst

... comment 0..1 string Comment
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept HeartRateMeasurementMethod
Binding: HartslagMeetMethodeCodelijst (extensible): HartslagMeetMethodeCodelijst

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(HCIM MedicalDevice Product) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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: Observation Reference Range Meaning Codes (extensible): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (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
... related SΣ 0..* BackboneElement Used when reporting vital signs panel components
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type S 1..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: has-member
.... target S 1..1 Reference(VitalSigns Profile NL) Resource that is related to this one
... component SΣC 0..* BackboneElement Component results
vs-3: If there is no a value a data absent reason must be present
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueAttachment Attachment
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.

.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservation Category Codes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.value[x]:valueQuantityrequiredVital Signs Units
http://hl7.org/fhir/ValueSet/ucum-vitals-common
from the FHIR Standard
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator
from the FHIR Standard
Observation.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard
Observation.interpretationextensibleHartslagRegelmatigheidCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20171231000000
from this IG
Observation.bodySiteexampleSNOMED CT Body Structures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodextensibleHartslagMeetMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20171231000000
from this IG
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.related.typerequiredFixed Value: has-member
http://hl7.org/fhir/ValueSet/observation-relationshiptypes
from the FHIR Standard
Observation.component.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard
Observation.component.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
vs-2errorObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
vs-3errorObservation.componentIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()
vs-4errorObservation.categoryMust have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='vital-signs').exists()

This structure is derived from Vital Signs HeartRate

Summary

Mandatory: 1 element

Differential View

This structure is derived from Vital Signs HeartRate

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Vital Signs HeartRate HeartRate
... identifier 0..* Identifier Business Identifier for observation
... subject 1..1 Reference(nl-core-patient) Who and/or what this is about
... effective[x] 1..1 dateTime, Period HeartRateDateTime
... valueQuantity:valueQuantity 1..1 Quantity HeartRateValue
... interpretation 0..1 CodeableConcept HeartbeatRegularity
Binding: HartslagRegelmatigheidCodelijst (extensible): HartslagRegelmatigheidCodelijst

... comment 0..1 string Comment
... method 0..1 CodeableConcept HeartRateMeasurementMethod
Binding: HartslagMeetMethodeCodelijst (extensible): HartslagMeetMethodeCodelijst


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.interpretationextensibleHartslagRegelmatigheidCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20171231000000
from this IG
Observation.methodextensibleHartslagMeetMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20171231000000
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Vital Signs HeartRate HeartRate
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
vs-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... category SC 1..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


vs-4: Must have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ 1..1 CodeableConcept Heart Rate
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:HeartRateCode Σ 0..* Coding Code defined by a terminology system
... subject SΣ 1..1 Reference(nl-core-patient) Who and/or what this is about
... effective[x] SΣ 1..1 HeartRateDateTime
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 1..* Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient) Who is responsible for the observation
.... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... Slices for value[x] ΣC 0..1 Quantity Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity SΣC 1..1 Quantity HeartRateValue
Binding: Vital Signs Units (required): Common UCUM units for recording Vital Signs

..... 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 responses from the common UCUM units for vital signs value set.
Fixed Value: /min
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..1 CodeableConcept HeartbeatRegularity
Binding: HartslagRegelmatigheidCodelijst (extensible): HartslagRegelmatigheidCodelijst

... comment 0..1 string Comment
... method 0..1 CodeableConcept HeartRateMeasurementMethod
Binding: HartslagMeetMethodeCodelijst (extensible): HartslagMeetMethodeCodelijst

... related SΣ 0..* BackboneElement Used when reporting vital signs panel components
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type S 1..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: has-member
.... target S 1..1 Reference(VitalSigns Profile NL) Resource that is related to this one
... component SΣC 0..* BackboneElement Component results
vs-3: If there is no a value a data absent reason must be present
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueAttachment Attachment
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservation Category Codes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.value[x]:valueQuantityrequiredVital Signs Units
http://hl7.org/fhir/ValueSet/ucum-vitals-common
from the FHIR Standard
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator
from the FHIR Standard
Observation.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard
Observation.interpretationextensibleHartslagRegelmatigheidCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20171231000000
from this IG
Observation.methodextensibleHartslagMeetMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20171231000000
from this IG
Observation.related.typerequiredFixed Value: has-member
http://hl7.org/fhir/ValueSet/observation-relationshiptypes
from the FHIR Standard
Observation.component.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
vs-2errorObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
vs-3errorObservation.componentIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()
vs-4errorObservation.categoryMust have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='vital-signs').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Vital Signs HeartRate HeartRate
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
vs-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... 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: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 | ProcedureRequest | ReferralRequest) Fulfills plan, proposal or order
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category SC 1..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


vs-4: Must have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ 1..1 CodeableConcept Heart Rate
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:HeartRateCode Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..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
Fixed Value: 8867-4
...... 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(nl-core-patient) Who and/or what this is about
... context 0..1 Reference(nl-core-episodeofcare | HCIM Encounter | gp-Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 HeartRateDateTime
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this was made available
... performer SΣ 1..* Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient) Who is responsible for the observation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for value[x] ΣC 0..1 Quantity Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity SΣC 1..1 Quantity HeartRateValue
Binding: Vital Signs Units (required): Common UCUM units for recording Vital Signs

..... id 0..1 string xml:id (or equivalent in JSON)
..... 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 responses from the common UCUM units for vital signs value set.
Fixed Value: /min
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..1 CodeableConcept HeartbeatRegularity
Binding: HartslagRegelmatigheidCodelijst (extensible): HartslagRegelmatigheidCodelijst

... comment 0..1 string Comment
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept HeartRateMeasurementMethod
Binding: HartslagMeetMethodeCodelijst (extensible): HartslagMeetMethodeCodelijst

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(HCIM MedicalDevice Product) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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: Observation Reference Range Meaning Codes (extensible): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (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
... related SΣ 0..* BackboneElement Used when reporting vital signs panel components
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type S 1..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: has-member
.... target S 1..1 Reference(VitalSigns Profile NL) Resource that is related to this one
... component SΣC 0..* BackboneElement Component results
vs-3: If there is no a value a data absent reason must be present
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Vital Signs (extensible): This identifies the vital sign result type.

.... value[x] SΣC 0..1 Vital Sign Value recorded with UCUM
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueAttachment Attachment
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason SC 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.

.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservation Category Codes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.value[x]:valueQuantityrequiredVital Signs Units
http://hl7.org/fhir/ValueSet/ucum-vitals-common
from the FHIR Standard
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator
from the FHIR Standard
Observation.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard
Observation.interpretationextensibleHartslagRegelmatigheidCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20171231000000
from this IG
Observation.bodySiteexampleSNOMED CT Body Structures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodextensibleHartslagMeetMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20171231000000
from this IG
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.related.typerequiredFixed Value: has-member
http://hl7.org/fhir/ValueSet/observation-relationshiptypes
from the FHIR Standard
Observation.component.codeextensibleVital Signs
http://hl7.org/fhir/ValueSet/observation-vitalsignresult
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason
from the FHIR Standard
Observation.component.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
vs-2errorObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
vs-3errorObservation.componentIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()
vs-4errorObservation.categoryMust have a category of 'vital-signs' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='vital-signs').exists()

This structure is derived from Vital Signs HeartRate

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel, Schematron