Open mHealth to HL7 FHIR® Implementation Guide CI Build

Open mHealth to FHIR - Local Development build (v0.0.0). See the Directory of published versions

StructureDefinition-omh-obs

source file: source/pages/_includes/omh-obs-intro.md

Open mHealth Observation Profile used as the target structure when mapping from OMH Schema

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://www.fhir.org/guides/omhtofhir/StructureDefinition/omh-obs

Published on Thu Jun 06 00:00:00 PDT 2019 as active by the Open mHealth.

This profile builds on Observation

Summary

Must-Support: 18 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... observation-specimenCode S0..1CodeableConceptA code representing the the type of specimen used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-specimenCode
Binding: v2 Specimen Type (example)
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1coderegistered | preliminary | final | amended +
Fixed Value: unknown
... category S0..*CodeableConceptClassification of type of observation
... code S1..1CodeableConceptType of observation (code / type)
... subject S0..1Reference()Who and/or what the observation is about
... effective[x] S0..1dateTime, Period, Timing, instantClinically relevant time/time-period for observation
... issued S0..1instantDate/Time this version was made available
... value[x] S0..1QuantityActual result
... note S0..*AnnotationComments about the observation
... bodySite S0..1CodeableConceptObserved body part
... method S0..1CodeableConceptHow it was done
... specimen S0..1Reference(Specimen)Specimen used for this observation
... device S0..1Reference(Device | DeviceMetric)(Measurement) Device
.... extension-modality S0..*codeThe modality whereby the measure is obtained. Choice of sensed|self-reported .
URL: http://www.fhir.org/guides/omhtofhir/StructureDefinition/extension-modality
Binding: http://www.fhir.org/guides/omhtofhir/ValueSet/modality-codes (required)
... component S0..*BackboneElementComponent results
.... code S1..1CodeableConceptType of component observation (code / type)
.... value[x] S0..1Actual component result
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... observation-specimenCode SI0..1CodeableConceptA code representing the the type of specimen used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-specimenCode
Binding: v2 Specimen Type (example)
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: unknown
... category SI0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject SΣI0..1Reference()Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued SΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1QuantityActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note SI0..*AnnotationComments about the observation
... bodySite SI0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method SI0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen SI0..1Reference(Specimen)Specimen used for this observation
... device SI0..1Reference(Device | DeviceMetric)(Measurement) Device
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension-modality SI0..*codeThe modality whereby the measure is obtained. Choice of sensed|self-reported .
URL: http://www.fhir.org/guides/omhtofhir/StructureDefinition/extension-modality
Binding: http://www.fhir.org/guides/omhtofhir/ValueSet/modality-codes (required)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣI0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
.... value[x] SΣI0..1Actual component result
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*See referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

Summary

Must-Support: 18 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... observation-specimenCode S0..1CodeableConceptA code representing the the type of specimen used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-specimenCode
Binding: v2 Specimen Type (example)
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1coderegistered | preliminary | final | amended +
Fixed Value: unknown
... category S0..*CodeableConceptClassification of type of observation
... code S1..1CodeableConceptType of observation (code / type)
... subject S0..1Reference()Who and/or what the observation is about
... effective[x] S0..1dateTime, Period, Timing, instantClinically relevant time/time-period for observation
... issued S0..1instantDate/Time this version was made available
... value[x] S0..1QuantityActual result
... note S0..*AnnotationComments about the observation
... bodySite S0..1CodeableConceptObserved body part
... method S0..1CodeableConceptHow it was done
... specimen S0..1Reference(Specimen)Specimen used for this observation
... device S0..1Reference(Device | DeviceMetric)(Measurement) Device
.... extension-modality S0..*codeThe modality whereby the measure is obtained. Choice of sensed|self-reported .
URL: http://www.fhir.org/guides/omhtofhir/StructureDefinition/extension-modality
Binding: http://www.fhir.org/guides/omhtofhir/ValueSet/modality-codes (required)
... component S0..*BackboneElementComponent results
.... code S1..1CodeableConceptType of component observation (code / type)
.... value[x] S0..1Actual component result
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... observation-specimenCode SI0..1CodeableConceptA code representing the the type of specimen used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-specimenCode
Binding: v2 Specimen Type (example)
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: unknown
... category SI0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject SΣI0..1Reference()Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued SΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1QuantityActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note SI0..*AnnotationComments about the observation
... bodySite SI0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method SI0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen SI0..1Reference(Specimen)Specimen used for this observation
... device SI0..1Reference(Device | DeviceMetric)(Measurement) Device
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension-modality SI0..*codeThe modality whereby the measure is obtained. Choice of sensed|self-reported .
URL: http://www.fhir.org/guides/omhtofhir/StructureDefinition/extension-modality
Binding: http://www.fhir.org/guides/omhtofhir/ValueSet/modality-codes (required)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣI0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
.... value[x] SΣI0..1Actual component result
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*See referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of Server RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.