US Public Health Profiles Library
0.0.1 - CI Build United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). This is not an authorized publication; it is the continuous build for version 0.0.1). This version is based on the current content of https://github.com/HL7/fhir-us-phpl/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Pregnancy Status Observation

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-pregnancy-status-observation Version: 0.0.1
Active as of 2022-06-09 Computable Name: USPublicHealthPregnancyStatusObservation

This profile represents current and/or prior pregnancy statuses and their date ranges, enabling investigators to determine if a patient was pregnant, possibly pregnant, not pregnant or whether the pregnancy status was unknown during a particular date range.

The subject of this profile is the mother.

This profile includes the determination method, determination date, and recorded date of the pregnancy status.

Use the effectivePeriod to indicate the date range over which the patient was pregnant/possibly pregnant/not pregnant/unknown. To record the date that the pregnancy status was recorded, use the date-recorded-extension and to record the date on which the pregnancy status determination was made, use the date-determined-extension. If the effectivePeriod.end is not present it is assumed that the date range over which the pregnancy status is asserted is from effectivePeriod.start to the date in the date-recorded-extension. For example, if the effectivePeriod.start has been recorded as two months prior to the date contained in the date-recorded-extension, and there is no effectivePeriod.end recorded, no assumptions can be made about the pregnancy status after the date contained in the date-recorded-extension.

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

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

This structure is derived from Observation

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the value of type:value

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationUS Public Health Pregnancy Status Observation
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... lib-copy-us-ph-date-recorded-extension S0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-recorded-extension
... lib-copy-us-ph-date-determined-extension S0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
... subject S1..1Reference(US Public Health Patient)Who and/or what the observation is about
... effective[x] S0..1PeriodPregnancy status date range
... value[x] S0..1CodeableConceptPregnancy Status
Binding: US Public Health Pregnancy Status (extensible): Pregnancy Status

... method S0..1CodeableConceptPregnancy status determination method
Binding: Pregnancy Status Determination Method (extensible): Pregnancy Status Determination Method

... Slices for component S0..*BackboneElementComponent results
Slice: Unordered, Open by type:value
.... component:sliceEstimatedGestationalAgeOfPregnancy S0..*BackboneElementEstimated Gestational Age of Pregnancy
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... code S1..1CodeableConceptEstimated Gestational Age
Binding: Estimated Gestational Age Code Including Method (extensible): Estimated Gestational Age Code Including Method

..... value[x] S1..1QuantityEstimated gestational age (days)
Required Pattern: At least the following
...... unit1..1stringUnit representation
Fixed Value: d
.... component:sliceEstimatedDateOfDelivery S0..*BackboneElementEstimated Date of Delivery (EDD)
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... code S1..1CodeableConceptEstimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method (extensible): Estimated Date of Delivery Including Method

..... value[x] S1..1dateTimeEstimated delivery date (EDD)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Public Health Pregnancy Status Observation
... id Σ0..1stringLogical 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... lib-copy-us-ph-date-recorded-extension S0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-recorded-extension
... lib-copy-us-ph-date-determined-extension S0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Public Health Patient)Who and/or what the observation is about
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣ0..1PeriodPregnancy status date range
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1CodeableConceptPregnancy Status
Binding: US Public Health Pregnancy Status (extensible): Pregnancy Status

... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method S0..1CodeableConceptPregnancy status determination method
Binding: Pregnancy Status Determination Method (extensible): Pregnancy Status Determination Method

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SΣ0..*BackboneElementComponent results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:sliceEstimatedGestationalAgeOfPregnancy SΣ0..*BackboneElementEstimated Gestational Age of Pregnancy
..... id 0..1stringUnique id for inter-element referencing
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptEstimated Gestational Age
Binding: Estimated Gestational Age Code Including Method (extensible): Estimated Gestational Age Code Including Method

..... value[x] SΣ1..1QuantityEstimated gestational age (days)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... value0..1decimalNumerical value (with implicit precision)
...... comparator0..1code< | <= | >= | > - how to understand the value
...... unit1..1stringUnit representation
Fixed Value: d
...... system0..1uriSystem that defines coded unit form
...... code0..1codeCoded form of the unit
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:sliceEstimatedDateOfDelivery SΣ0..*BackboneElementEstimated Date of Delivery (EDD)
..... id 0..1stringUnique id for inter-element referencing
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptEstimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method (extensible): Estimated Date of Delivery Including Method

..... value[x] SΣ1..1dateTimeEstimated delivery date (EDD)
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Public Health Pregnancy Status Observation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... lib-copy-us-ph-date-recorded-extension 0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-recorded-extension
... lib-copy-us-ph-date-determined-extension 0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
... subject Σ1..1Reference(US Public Health Patient)Who and/or what the observation is about
... effective[x] Σ0..1PeriodPregnancy status date range
... value[x] ΣI0..1CodeableConceptPregnancy Status
Binding: US Public Health Pregnancy Status (extensible): Pregnancy Status

... method 0..1CodeableConceptPregnancy status determination method
Binding: Pregnancy Status Determination Method (extensible): Pregnancy Status Determination Method

... Slices for component Σ0..*BackboneElementComponent results
Slice: Unordered, Open by type:value
.... component:sliceEstimatedGestationalAgeOfPregnancy Σ0..*BackboneElementEstimated Gestational Age of Pregnancy
..... lib-copy-us-ph-date-determined-extension 0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... code Σ1..1CodeableConceptEstimated Gestational Age
Binding: Estimated Gestational Age Code Including Method (extensible): Estimated Gestational Age Code Including Method

..... value[x] Σ1..1QuantityEstimated gestational age (days)
Required Pattern: At least the following
...... unit1..1stringUnit representation
Fixed Value: d
.... component:sliceEstimatedDateOfDelivery Σ0..*BackboneElementEstimated Date of Delivery (EDD)
..... lib-copy-us-ph-date-determined-extension 0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... code Σ1..1CodeableConceptEstimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method (extensible): Estimated Date of Delivery Including Method

..... value[x] Σ1..1dateTimeEstimated delivery date (EDD)

doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the value of type:value

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationUS Public Health Pregnancy Status Observation
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... lib-copy-us-ph-date-recorded-extension S0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-recorded-extension
... lib-copy-us-ph-date-determined-extension S0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
... subject S1..1Reference(US Public Health Patient)Who and/or what the observation is about
... effective[x] S0..1PeriodPregnancy status date range
... value[x] S0..1CodeableConceptPregnancy Status
Binding: US Public Health Pregnancy Status (extensible): Pregnancy Status

... method S0..1CodeableConceptPregnancy status determination method
Binding: Pregnancy Status Determination Method (extensible): Pregnancy Status Determination Method

... Slices for component S0..*BackboneElementComponent results
Slice: Unordered, Open by type:value
.... component:sliceEstimatedGestationalAgeOfPregnancy S0..*BackboneElementEstimated Gestational Age of Pregnancy
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... code S1..1CodeableConceptEstimated Gestational Age
Binding: Estimated Gestational Age Code Including Method (extensible): Estimated Gestational Age Code Including Method

..... value[x] S1..1QuantityEstimated gestational age (days)
Required Pattern: At least the following
...... unit1..1stringUnit representation
Fixed Value: d
.... component:sliceEstimatedDateOfDelivery S0..*BackboneElementEstimated Date of Delivery (EDD)
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... code S1..1CodeableConceptEstimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method (extensible): Estimated Date of Delivery Including Method

..... value[x] S1..1dateTimeEstimated delivery date (EDD)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Public Health Pregnancy Status Observation
... id Σ0..1stringLogical 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... lib-copy-us-ph-date-recorded-extension S0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-recorded-extension
... lib-copy-us-ph-date-determined-extension S0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Public Health Patient)Who and/or what the observation is about
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣ0..1PeriodPregnancy status date range
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1CodeableConceptPregnancy Status
Binding: US Public Health Pregnancy Status (extensible): Pregnancy Status

... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method S0..1CodeableConceptPregnancy status determination method
Binding: Pregnancy Status Determination Method (extensible): Pregnancy Status Determination Method

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SΣ0..*BackboneElementComponent results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:sliceEstimatedGestationalAgeOfPregnancy SΣ0..*BackboneElementEstimated Gestational Age of Pregnancy
..... id 0..1stringUnique id for inter-element referencing
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptEstimated Gestational Age
Binding: Estimated Gestational Age Code Including Method (extensible): Estimated Gestational Age Code Including Method

..... value[x] SΣ1..1QuantityEstimated gestational age (days)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... value0..1decimalNumerical value (with implicit precision)
...... comparator0..1code< | <= | >= | > - how to understand the value
...... unit1..1stringUnit representation
Fixed Value: d
...... system0..1uriSystem that defines coded unit form
...... code0..1codeCoded form of the unit
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:sliceEstimatedDateOfDelivery SΣ0..*BackboneElementEstimated Date of Delivery (EDD)
..... id 0..1stringUnique id for inter-element referencing
..... lib-copy-us-ph-date-determined-extension S0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/lib-copy-us-ph-date-determined-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptEstimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method (extensible): Estimated Date of Delivery Including Method

..... value[x] SΣ1..1dateTimeEstimated delivery date (EDD)
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


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

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexamplePattern: LOINC code 82810-3
Observation.value[x]extensibleUSPublicHealthPregnancyStatus
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodextensiblePregnancy Status Determination Method
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:sliceEstimatedGestationalAgeOfPregnancy.codeextensibleEstimated Gestational Age Code Including Method
Observation.component:sliceEstimatedGestationalAgeOfPregnancy.dataAbsentReasonextensibleDataAbsentReason
Observation.component:sliceEstimatedGestationalAgeOfPregnancy.interpretationextensibleObservationInterpretationCodes
Observation.component:sliceEstimatedDateOfDelivery.codeextensibleEstimated Date of Delivery Including Method
Observation.component:sliceEstimatedDateOfDelivery.dataAbsentReasonextensibleDataAbsentReason
Observation.component:sliceEstimatedDateOfDelivery.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePathDetailsRequirements
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeObservationA resource should have narrative for robust management
: text.`div`.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
ele-1errorObservation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.extension:extensionPregnancyStatusRecordedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.extension:extensionPregnancyStatusRecordedDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.extension:extensionPregnancyStatusDeterminationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.extension:extensionPregnancyStatusDeterminationDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1errorObservation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedGestationalAgeOfPregnancy.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedDateOfDeliveryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:sliceEstimatedDateOfDelivery.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:sliceEstimatedDateOfDelivery.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:sliceEstimatedDateOfDelivery.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())