Current Build

​ D.4.1 StructureDefinition: hspc-bodyWeight

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/fpar/StructureDefinition/hspc-bodyWeight

This profile builds on Observation.

This profile was published on Thu Apr 27 00:00:00 EDT 2017 as a draft by HSPC.

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

This structure is derived from Observation

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 2 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IHSPC Body Weight
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... deltaFlag 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-deltaFlag profiled by http://hl7.org/fhir/fpar/StructureDefinition/deltaFlag
Binding: Abnormal Interpretation Numeric Nom (preferred)
... dataOriginationMode 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataOriginationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataOriginationMode
Binding: http://hl7.org/fhir/fpar/ValueSet/observation-dataOriginationMode (preferred)
... associatedPrecondition 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-associatedPrecondition profiled by http://hl7.org/fhir/fpar/StructureDefinition/associatedPrecondition
Binding: HSPC Body Weight Associated Precondition (preferred)
... code CodeableConceptFixed Value: {"coding":[{"system":"http://loinc.org","code":"29463-7","display":"Body weight"}]}
... issued 0..0
... performer 0..1​Reference(FPAR Practitioner Profile | HSPC Organization Profile | FPAR Patient Profile)
... valueQuantity 1..1Quantity
.... system uriFixed Value: http://unitsofmeasure.org
.... code Binding: HSPC Weight Units of Measure Value Set (preferred)
... bodySite 0..0
... method Binding: http://hl7.org/fhir/fpar/CodeSystem/weightMeasMethodDevice (preferred)
... specimen 0..0
... related 0..0
... component 0..0

doco Documentation for this format

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*HSPC Body Weight
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... deltaFlag I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-deltaFlag profiled by http://hl7.org/fhir/fpar/StructureDefinition/deltaFlag
Binding: Abnormal Interpretation Numeric Nom (preferred)
ext-1: Must have either extensions or value[x], not both
... dataOriginationMode I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataOriginationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataOriginationMode
Binding: http://hl7.org/fhir/fpar/ValueSet/observation-dataOriginationMode (preferred)
ext-1: Must have either extensions or value[x], not both
... associatedPrecondition I0..*CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-associatedPrecondition profiled by http://hl7.org/fhir/fpar/StructureDefinition/associatedPrecondition
Binding: HSPC Body Weight Associated Precondition (preferred)
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI1..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
... code 1..1CodeableConceptLaboratory Test or Observation Name
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"29463-7","display":"Body weight"}]}
... subject SΣ1..1Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣI0..1dateTime, PeriodClinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..1​Reference(FPAR Practitioner Profile | HSPC Organization Profile | FPAR Patient Profile | RelatedPerson)Who is responsible for the observation
... valueQuantity SΣI1..1QuantityA measured or measurable amount
us-core-3: SHALL use UCUM for coded quantity units.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit Σ0..1stringUnit representation
.... system 0..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
.... code 0..1codeCoded form of the unit
Binding: HSPC Weight Units of Measure Value Set (preferred)
... 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: http://hl7.org/fhir/fpar/CodeSystem/weightMeasMethodDevice (preferred)
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides 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 I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation

doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 2 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IHSPC Body Weight
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... deltaFlag 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-deltaFlag profiled by http://hl7.org/fhir/fpar/StructureDefinition/deltaFlag
Binding: Abnormal Interpretation Numeric Nom (preferred)
... dataOriginationMode 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataOriginationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataOriginationMode
Binding: http://hl7.org/fhir/fpar/ValueSet/observation-dataOriginationMode (preferred)
... associatedPrecondition 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-associatedPrecondition profiled by http://hl7.org/fhir/fpar/StructureDefinition/associatedPrecondition
Binding: HSPC Body Weight Associated Precondition (preferred)
... code CodeableConceptFixed Value: {"coding":[{"system":"http://loinc.org","code":"29463-7","display":"Body weight"}]}
... issued 0..0
... performer 0..1​Reference(FPAR Practitioner Profile | HSPC Organization Profile | FPAR Patient Profile)
... valueQuantity 1..1Quantity
.... system uriFixed Value: http://unitsofmeasure.org
.... code Binding: HSPC Weight Units of Measure Value Set (preferred)
... bodySite 0..0
... method Binding: http://hl7.org/fhir/fpar/CodeSystem/weightMeasMethodDevice (preferred)
... specimen 0..0
... related 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*HSPC Body Weight
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... deltaFlag I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-deltaFlag profiled by http://hl7.org/fhir/fpar/StructureDefinition/deltaFlag
Binding: Abnormal Interpretation Numeric Nom (preferred)
ext-1: Must have either extensions or value[x], not both
... dataOriginationMode I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataOriginationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataOriginationMode
Binding: http://hl7.org/fhir/fpar/ValueSet/observation-dataOriginationMode (preferred)
ext-1: Must have either extensions or value[x], not both
... associatedPrecondition I0..*CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-associatedPrecondition profiled by http://hl7.org/fhir/fpar/StructureDefinition/associatedPrecondition
Binding: HSPC Body Weight Associated Precondition (preferred)
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI1..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
... code 1..1CodeableConceptLaboratory Test or Observation Name
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"29463-7","display":"Body weight"}]}
... subject SΣ1..1Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣI0..1dateTime, PeriodClinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..1​Reference(FPAR Practitioner Profile | HSPC Organization Profile | FPAR Patient Profile | RelatedPerson)Who is responsible for the observation
... valueQuantity SΣI1..1QuantityA measured or measurable amount
us-core-3: SHALL use UCUM for coded quantity units.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit Σ0..1stringUnit representation
.... system 0..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
.... code 0..1codeCoded form of the unit
Binding: HSPC Weight Units of Measure Value Set (preferred)
... 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: http://hl7.org/fhir/fpar/CodeSystem/weightMeasMethodDevice (preferred)
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides 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 I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.extensionHSPC Body Weight Associated PreconditionpreferredHSPC Body Weight Associated Precondition
Observation.extensionHSPC Body Weight Associated PreconditionpreferredHSPC Body Weight Associated Precondition
Observation.extensionHSPC Body Weight Associated PreconditionpreferredHSPC Body Weight Associated Precondition
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.valueQuantity.codeHSPC Weight Units of Measure Value SetpreferredHSPC Weight Units of Measure Value Set
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.method?extpreferredhttp://hl7.org/fhir/fpar/CodeSystem/weightMeasMethodDevice
Observation.referenceRange.typeObservation Reference Range Meaning CodesextensibleObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToObservation Reference Range Applies To CodesexampleObservation Reference Range Applies To 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
: contained.contained.empty()
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ObservationIf 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-3ObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or code!=component.code
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
us-core-2ObservationIf 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)
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-5Observation.categoryMust have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='laboratory').exists()
us-core-1Observation.effective[x]Datetime must be at least to day.
: ($this as dateTime).toString().length() >= 8
us-core-3Observation.valueQuantitySHALL use UCUM for coded quantity units.
: valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org'
ele-1Observation.referenceRangeAll FHIR elements must have a @value or children
: children().count() > id.count()
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
.