STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-vitalsigns

The official URL for this profile is: 

http://hl7.org/fhir/us/daf/StructureDefinition/daf-vitalsigns

This profile was published on Thu Aug 21 00:00:00 AEST 2014 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.4.1.1 Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
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
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierUnique Id for this particular observation
... status ?!S1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S1..1CodeableConceptType of observation (code / type)
Binding: DAF Vital Sign Codes (extensible)
... subject S1..1Reference(Profile daf-patient)Who and/or what this is about
... encounter S0..1Reference(Profile daf-encounter)An interaction during which services are provided to the patient
... effective[x] S1..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer S0..1Reference(Profile daf-pract | Profile daf-patient | Profile daf-relatedperson | Profile daf-organization)Who is responsible for the observation
... valueQuantity SI0..1QuantityActual result
Binding: Common UCUM units (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S0..1decimalNumerical value (with implicit precision)
.... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit S0..1stringUnit representation
.... system SI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S0..1codeCoded form of the unit
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SI0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... low SI0..1QuantityLow Range, if relevant
Binding: Common UCUM units (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S0..1decimalNumerical value (with implicit precision)
..... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit S0..1stringUnit representation
..... system SI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S0..1codeCoded form of the unit
.... high SI0..1QuantityHigh Range, if relevant
Binding: Common UCUM units (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S0..1decimalNumerical value (with implicit precision)
..... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit S0..1stringUnit representation
..... system SI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S0..1codeCoded form of the unit
.... meaning S0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... related S0..1BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
Fixed Value: has-component
.... target S1..1Reference(Profile daf-vitalsigns)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation:dafvitalsigns.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
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
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierUnique Id for this particular observation
... status ?!S1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S1..1CodeableConceptType of observation (code / type)
Binding: DAF Vital Sign Codes (extensible)
... subject S1..1Reference(Profile daf-patient)Who and/or what this is about
... encounter S0..1Reference(Profile daf-encounter)An interaction during which services are provided to the patient
... effective[x] S1..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer S0..1Reference(Profile daf-pract | Profile daf-patient | Profile daf-relatedperson | Profile daf-organization)Who is responsible for the observation
... valueQuantity SI0..1QuantityActual result
Binding: Common UCUM units (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S0..1decimalNumerical value (with implicit precision)
.... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit S0..1stringUnit representation
.... system SI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S0..1codeCoded form of the unit
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SI0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... low SI0..1QuantityLow Range, if relevant
Binding: Common UCUM units (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S0..1decimalNumerical value (with implicit precision)
..... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit S0..1stringUnit representation
..... system SI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S0..1codeCoded form of the unit
.... high SI0..1QuantityHigh Range, if relevant
Binding: Common UCUM units (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S0..1decimalNumerical value (with implicit precision)
..... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit S0..1stringUnit representation
..... system SI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S0..1codeCoded form of the unit
.... meaning S0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... related S0..1BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
Fixed Value: has-component
.... target S1..1Reference(Profile daf-vitalsigns)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation:dafvitalsigns.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeDAF Vital Sign CodesextensibleDAF Vital Sign Codes
Observation.valueQuantityCommon UCUM unitsrequiredCommon UCUM units
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.lowCommon UCUM unitsrequiredCommon UCUM units
Observation.referenceRange.low.comparatorQuantityComparatorrequiredQuantityComparator
Observation.referenceRange.highCommon UCUM unitsrequiredCommon UCUM units
Observation.referenceRange.high.comparatorQuantityComparatorrequiredQuantityComparator
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
XPath: not(exists(f:value)) or not(count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0)
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
.