Current Build

​ D.4.1 StructureDefinition: hspc-householdSize

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This profile builds on US Core Results Profile.

This profile was published on Thu May 11 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 US Core Results Profile

Summary

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

Structures

This structure refers to these other structures:

  • unable to summarise profile http://hl7.org/fhir/fpar/StructureDefinition/hspc-provpract (no profile found)

This structure is derived from US Core Results Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IHSPC Household Size Profile
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... code 1..1CodeableConceptLaboratory Test Name
... performer 0..1Reference()
... valueQuantity 1..1Quantity
.... system uriFixed Value: http://unitsofmeasure.org
.... code codeFixed Value: {count}
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related ΣI0..0
... component ΣI0..0

doco Documentation for this format

This structure is derived from US Core Results Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*HSPC Household Size Profile
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..*ExtensionAdditional Content defined by implementations
... 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 SΣ1..1CodeableConceptLaboratory Test Name
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"86639-2","display":"Household size"}]}
... 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..1Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-provpract | http://hl7.org/fhir/fpar/StructureDefinition/hspc-organization | http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient | 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
Fixed Value: {count}
... 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

doco Documentation for this format

This structure is derived from US Core Results Profile

Summary

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

Structures

This structure refers to these other structures:

  • unable to summarise profile http://hl7.org/fhir/fpar/StructureDefinition/hspc-provpract (no profile found)

Differential View

This structure is derived from US Core Results Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IHSPC Household Size Profile
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... code 1..1CodeableConceptLaboratory Test Name
... performer 0..1Reference()
... valueQuantity 1..1Quantity
.... system uriFixed Value: http://unitsofmeasure.org
.... code codeFixed Value: {count}
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related ΣI0..0
... component ΣI0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*HSPC Household Size Profile
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..*ExtensionAdditional Content defined by implementations
... 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 SΣ1..1CodeableConceptLaboratory Test Name
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"86639-2","display":"Household size"}]}
... 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..1Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-provpract | http://hl7.org/fhir/fpar/StructureDefinition/hspc-organization | http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient | 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
Fixed Value: {count}
... 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

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
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)
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'
.