US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ 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/us-ph-pregnancy-status-observation Version: 1.0.0
Active as of 2024-08-13 Computable Name: USPublicHealthPregnancyStatusObservation

This Observation 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:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation Observation
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extensionPregnancyStatusRecordedDate S 0..1 dateTime Pregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-recorded-extension
.... extensionPregnancyStatusDeterminationDate S 0..1 dateTime Pregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
... code S 1..1 CodeableConcept Type of observation (code / type)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82810-3
... subject S 1..1 Reference(US Public Health Patient) Who and/or what the observation is about
... value[x] S 1..1 CodeableConcept Pregnancy Status
Binding: US Public Health VaueSet - Pregnancy Status (extensible): Pregnancy Status

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

... Slices for component S 0..* BackboneElement Component results
Slice: Unordered, Open by type:value
.... component:estimatedGestationalAgeOfPregnancy S 0..* BackboneElement Estimated Gestational Age of Pregnancy
..... us-ph-date-determined-extension S 0..1 dateTime Estimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... code S 1..1 CodeableConcept Estimated Gestational Age
Binding: Estimated Gestational Age Code Including Method . (extensible): Estimated Gestational Age Code Including Method

..... value[x] S 1..1 Quantity Estimated gestational age (days)
Required Pattern: At least the following
...... unit 1..1 string Unit representation
Fixed Value: d
.... component:estimatedDateOfDelivery S 0..* BackboneElement Estimated Date of Delivery (EDD)
..... us-ph-date-determined-extension S 0..1 dateTime Estimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... code S 1..1 CodeableConcept Estimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method . (extensible): Estimated Date of Delivery Including Method

..... value[x] S 1..1 dateTime Estimated delivery date (EDD)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.value[x]extensibleUSPublicHealthValueSetPregnancyStatus
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-pregnancy-status
from this IG
Observation.methodextensiblePregnancyStatusDeterminationMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80
Observation.component:estimatedGestationalAgeOfPregnancy.codeextensibleEstimatedGestationalAgeCodeIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82
Observation.component:estimatedDateOfDelivery.codeextensibleEstimatedDateOfDeliveryIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extensionPregnancyStatusRecordedDate S 0..1 dateTime Pregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-recorded-extension
.... extensionPregnancyStatusDeterminationDate S 0..1 dateTime Pregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82810-3
... subject SΣ 1..1 Reference(US Public Health Patient) Who and/or what the observation is about
... effective[x] SΣ 0..1 Period Pregnancy status date range
... value[x] SΣC 1..1 CodeableConcept Pregnancy Status
Binding: US Public Health VaueSet - Pregnancy Status (extensible): Pregnancy Status

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

... Slices for component SΣ 0..* BackboneElement Component results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:estimatedGestationalAgeOfPregnancy SΣ 0..* BackboneElement Estimated Gestational Age of Pregnancy
..... us-ph-date-determined-extension S 0..1 dateTime Estimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Gestational Age
Binding: Estimated Gestational Age Code Including Method . (extensible): Estimated Gestational Age Code Including Method

..... value[x] SΣ 1..1 Quantity Estimated gestational age (days)
Required Pattern: At least the following
...... unit 1..1 string Unit representation
Fixed Value: d
.... component:estimatedDateOfDelivery SΣ 0..* BackboneElement Estimated Date of Delivery (EDD)
..... us-ph-date-determined-extension S 0..1 dateTime Estimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method . (extensible): Estimated Date of Delivery Including Method

..... value[x] SΣ 1..1 dateTime Estimated delivery date (EDD)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.codeexamplePattern: LOINC Code 82810-3
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.value[x]extensibleUSPublicHealthValueSetPregnancyStatus
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-pregnancy-status
from this IG
Observation.methodextensiblePregnancyStatusDeterminationMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:estimatedGestationalAgeOfPregnancy.codeextensibleEstimatedGestationalAgeCodeIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82
Observation.component:estimatedDateOfDelivery.codeextensibleEstimatedDateOfDeliveryIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extensionPregnancyStatusRecordedDate S 0..1 dateTime Pregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-recorded-extension
.... extensionPregnancyStatusDeterminationDate S 0..1 dateTime Pregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business 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..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

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


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


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82810-3
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(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..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 Period Pregnancy status date range
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] SΣC 1..1 CodeableConcept Pregnancy Status
Binding: US Public Health VaueSet - Pregnancy Status (extensible): Pregnancy Status

... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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

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

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text 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..* BackboneElement Component results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:estimatedGestationalAgeOfPregnancy SΣ 0..* BackboneElement Estimated Gestational Age of Pregnancy
..... id 0..1 string Unique id for inter-element referencing
..... us-ph-date-determined-extension S 0..1 dateTime Estimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Gestational Age
Binding: Estimated Gestational Age Code Including Method . (extensible): Estimated Gestational Age Code Including Method

..... value[x] SΣ 1..1 Quantity Estimated gestational age (days)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 decimal Numerical value (with implicit precision)
...... comparator 0..1 code < | <= | >= | > - how to understand the value
...... unit 1..1 string Unit representation
Fixed Value: d
...... system 0..1 uri System that defines coded unit form
...... code 0..1 code Coded form of the unit
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:estimatedDateOfDelivery SΣ 0..* BackboneElement Estimated Date of Delivery (EDD)
..... id 0..1 string Unique id for inter-element referencing
..... us-ph-date-determined-extension S 0..1 dateTime Estimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method . (extensible): Estimated Date of Delivery Including Method

..... value[x] SΣ 1..1 dateTime Estimated delivery date (EDD)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, 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

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexamplePattern: LOINC Code 82810-3
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.value[x]extensibleUSPublicHealthValueSetPregnancyStatus
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-pregnancy-status
from this IG
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodextensiblePregnancyStatusDeterminationMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:estimatedGestationalAgeOfPregnancy.codeextensibleEstimatedGestationalAgeCodeIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82
Observation.component:estimatedGestationalAgeOfPregnancy.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:estimatedGestationalAgeOfPregnancy.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:estimatedDateOfDelivery.codeextensibleEstimatedDateOfDeliveryIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81
Observation.component:estimatedDateOfDelivery.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:estimatedDateOfDelivery.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

This structure is derived from Observation

Summary

Mandatory: 2 elements(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 1 is sliced based on the value of Observation.component

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation Observation
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extensionPregnancyStatusRecordedDate S 0..1 dateTime Pregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-recorded-extension
.... extensionPregnancyStatusDeterminationDate S 0..1 dateTime Pregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
... code S 1..1 CodeableConcept Type of observation (code / type)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82810-3
... subject S 1..1 Reference(US Public Health Patient) Who and/or what the observation is about
... value[x] S 1..1 CodeableConcept Pregnancy Status
Binding: US Public Health VaueSet - Pregnancy Status (extensible): Pregnancy Status

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

... Slices for component S 0..* BackboneElement Component results
Slice: Unordered, Open by type:value
.... component:estimatedGestationalAgeOfPregnancy S 0..* BackboneElement Estimated Gestational Age of Pregnancy
..... us-ph-date-determined-extension S 0..1 dateTime Estimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... code S 1..1 CodeableConcept Estimated Gestational Age
Binding: Estimated Gestational Age Code Including Method . (extensible): Estimated Gestational Age Code Including Method

..... value[x] S 1..1 Quantity Estimated gestational age (days)
Required Pattern: At least the following
...... unit 1..1 string Unit representation
Fixed Value: d
.... component:estimatedDateOfDelivery S 0..* BackboneElement Estimated Date of Delivery (EDD)
..... us-ph-date-determined-extension S 0..1 dateTime Estimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... code S 1..1 CodeableConcept Estimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method . (extensible): Estimated Date of Delivery Including Method

..... value[x] S 1..1 dateTime Estimated delivery date (EDD)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.value[x]extensibleUSPublicHealthValueSetPregnancyStatus
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-pregnancy-status
from this IG
Observation.methodextensiblePregnancyStatusDeterminationMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80
Observation.component:estimatedGestationalAgeOfPregnancy.codeextensibleEstimatedGestationalAgeCodeIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82
Observation.component:estimatedDateOfDelivery.codeextensibleEstimatedDateOfDeliveryIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extensionPregnancyStatusRecordedDate S 0..1 dateTime Pregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-recorded-extension
.... extensionPregnancyStatusDeterminationDate S 0..1 dateTime Pregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82810-3
... subject SΣ 1..1 Reference(US Public Health Patient) Who and/or what the observation is about
... effective[x] SΣ 0..1 Period Pregnancy status date range
... value[x] SΣC 1..1 CodeableConcept Pregnancy Status
Binding: US Public Health VaueSet - Pregnancy Status (extensible): Pregnancy Status

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

... Slices for component SΣ 0..* BackboneElement Component results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:estimatedGestationalAgeOfPregnancy SΣ 0..* BackboneElement Estimated Gestational Age of Pregnancy
..... us-ph-date-determined-extension S 0..1 dateTime Estimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Gestational Age
Binding: Estimated Gestational Age Code Including Method . (extensible): Estimated Gestational Age Code Including Method

..... value[x] SΣ 1..1 Quantity Estimated gestational age (days)
Required Pattern: At least the following
...... unit 1..1 string Unit representation
Fixed Value: d
.... component:estimatedDateOfDelivery SΣ 0..* BackboneElement Estimated Date of Delivery (EDD)
..... us-ph-date-determined-extension S 0..1 dateTime Estimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method . (extensible): Estimated Date of Delivery Including Method

..... value[x] SΣ 1..1 dateTime Estimated delivery date (EDD)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.codeexamplePattern: LOINC Code 82810-3
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.value[x]extensibleUSPublicHealthValueSetPregnancyStatus
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-pregnancy-status
from this IG
Observation.methodextensiblePregnancyStatusDeterminationMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:estimatedGestationalAgeOfPregnancy.codeextensibleEstimatedGestationalAgeCodeIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82
Observation.component:estimatedDateOfDelivery.codeextensibleEstimatedDateOfDeliveryIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extensionPregnancyStatusRecordedDate S 0..1 dateTime Pregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-recorded-extension
.... extensionPregnancyStatusDeterminationDate S 0..1 dateTime Pregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business 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..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

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


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


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82810-3
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(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..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 Period Pregnancy status date range
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] SΣC 1..1 CodeableConcept Pregnancy Status
Binding: US Public Health VaueSet - Pregnancy Status (extensible): Pregnancy Status

... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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

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

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text 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..* BackboneElement Component results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:estimatedGestationalAgeOfPregnancy SΣ 0..* BackboneElement Estimated Gestational Age of Pregnancy
..... id 0..1 string Unique id for inter-element referencing
..... us-ph-date-determined-extension S 0..1 dateTime Estimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Gestational Age
Binding: Estimated Gestational Age Code Including Method . (extensible): Estimated Gestational Age Code Including Method

..... value[x] SΣ 1..1 Quantity Estimated gestational age (days)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 decimal Numerical value (with implicit precision)
...... comparator 0..1 code < | <= | >= | > - how to understand the value
...... unit 1..1 string Unit representation
Fixed Value: d
...... system 0..1 uri System that defines coded unit form
...... code 0..1 code Coded form of the unit
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:estimatedDateOfDelivery SΣ 0..* BackboneElement Estimated Date of Delivery (EDD)
..... id 0..1 string Unique id for inter-element referencing
..... us-ph-date-determined-extension S 0..1 dateTime Estimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept Estimated Date of Delivery code
Binding: Estimated Date of Delivery Including Method . (extensible): Estimated Date of Delivery Including Method

..... value[x] SΣ 1..1 dateTime Estimated delivery date (EDD)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, 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

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexamplePattern: LOINC Code 82810-3
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.value[x]extensibleUSPublicHealthValueSetPregnancyStatus
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-pregnancy-status
from this IG
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodextensiblePregnancyStatusDeterminationMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:estimatedGestationalAgeOfPregnancy.codeextensibleEstimatedGestationalAgeCodeIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82
Observation.component:estimatedGestationalAgeOfPregnancy.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:estimatedGestationalAgeOfPregnancy.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:estimatedDateOfDelivery.codeextensibleEstimatedDateOfDeliveryIncludingMethod .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81
Observation.component:estimatedDateOfDelivery.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:estimatedDateOfDelivery.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

This structure is derived from Observation

Summary

Mandatory: 2 elements(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 1 is sliced based on the value of Observation.component

 

Other representations of profile: CSV, Excel, Schematron