HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm CI Build

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.34 StructureDefinition-pregnancy-status-observation

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.

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.

SD.34.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/pregnancy-status-observation

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on Observation

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 15 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*ObservationPregnancy Status
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... date-recorded-extension S0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-recorded-extension
... date-determined-extension S0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/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(eCR Patient)
... effective[x] S0..1PeriodPregnancy status date range
... value[x] S0..1CodeableConceptPregnancy Status
Binding: Pregnancy Status (extensible)
... method S0..1CodeableConceptPregnancy status determination method
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.80/expansion (extensible)
... component 0..*(Slice Definition)Slice: Unordered, Open by type:value
.... component:sliceEstimatedGestationalAgeOfPregnancy S0..*BackboneElementEstimated Gestational Age of Pregnancy
..... date-determined-extension S0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... code S1..1CodeableConceptEstimated Gestational Age code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.82/expansion (extensible)
..... 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)
..... date-determined-extension S0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... code S1..1CodeableConceptEstimated Date of Delivery code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.81/expansion (extensible)
..... value[x] S1..1dateTimeEstimated delivery date (EDD)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*ObservationPregnancy Status
... 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
... date-recorded-extension SI0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-recorded-extension
... date-determined-extension SI0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier Σ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 ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
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ΣI1..1Reference(eCR Patient)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..1PeriodPregnancy status date range
... issued Σ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..1CodeableConceptPregnancy Status
Binding: Pregnancy Status (extensible)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method SI0..1CodeableConceptPregnancy status determination method
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.80/expansion (extensible)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device I0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..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 ΣI0..*(Slice Definition)Component results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... 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 ΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
..... value[x] ΣI0..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)
..... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
..... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result
.... component:sliceEstimatedGestationalAgeOfPregnancy SΣI0..*BackboneElementEstimated Gestational Age of Pregnancy
..... id 0..1stringUnique id for inter-element referencing
..... date-determined-extension SI0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣI1..1CodeableConceptEstimated Gestational Age code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.82/expansion (extensible)
..... value[x] SΣI1..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)
..... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
..... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result
.... component:sliceEstimatedDateOfDelivery SΣI0..*BackboneElementEstimated Date of Delivery (EDD)
..... id 0..1stringUnique id for inter-element referencing
..... date-determined-extension SI0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣI1..1CodeableConceptEstimated Date of Delivery code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.81/expansion (extensible)
..... value[x] SΣI1..1dateTimeEstimated delivery date (EDD)
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
..... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
..... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 15 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*ObservationPregnancy Status
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... date-recorded-extension S0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-recorded-extension
... date-determined-extension S0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/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(eCR Patient)
... effective[x] S0..1PeriodPregnancy status date range
... value[x] S0..1CodeableConceptPregnancy Status
Binding: Pregnancy Status (extensible)
... method S0..1CodeableConceptPregnancy status determination method
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.80/expansion (extensible)
... component 0..*(Slice Definition)Slice: Unordered, Open by type:value
.... component:sliceEstimatedGestationalAgeOfPregnancy S0..*BackboneElementEstimated Gestational Age of Pregnancy
..... date-determined-extension S0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... code S1..1CodeableConceptEstimated Gestational Age code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.82/expansion (extensible)
..... 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)
..... date-determined-extension S0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... code S1..1CodeableConceptEstimated Date of Delivery code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.81/expansion (extensible)
..... value[x] S1..1dateTimeEstimated delivery date (EDD)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*ObservationPregnancy Status
... 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
... date-recorded-extension SI0..1dateTimePregnancy Status Recorded Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-recorded-extension
... date-determined-extension SI0..1dateTimePregnancy Status Determination Date
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier Σ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 ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
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ΣI1..1Reference(eCR Patient)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..1PeriodPregnancy status date range
... issued Σ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..1CodeableConceptPregnancy Status
Binding: Pregnancy Status (extensible)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method SI0..1CodeableConceptPregnancy status determination method
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.80/expansion (extensible)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device I0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..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 ΣI0..*(Slice Definition)Component results
Slice: Unordered, Open by type:value
.... component:All Slices Content/Rules for all slices
..... 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 ΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
..... value[x] ΣI0..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)
..... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
..... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result
.... component:sliceEstimatedGestationalAgeOfPregnancy SΣI0..*BackboneElementEstimated Gestational Age of Pregnancy
..... id 0..1stringUnique id for inter-element referencing
..... date-determined-extension SI0..1dateTimeEstimated gestational age of pregnancy determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣI1..1CodeableConceptEstimated Gestational Age code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.82/expansion (extensible)
..... value[x] SΣI1..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)
..... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
..... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result
.... component:sliceEstimatedDateOfDelivery SΣI0..*BackboneElementEstimated Date of Delivery (EDD)
..... id 0..1stringUnique id for inter-element referencing
..... date-determined-extension SI0..1dateTimeEstimated date of delivery (EDD) determination date.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/date-determined-extension
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣI1..1CodeableConceptEstimated Date of Delivery code
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.81/expansion (extensible)
..... value[x] SΣI1..1dateTimeEstimated delivery date (EDD)
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
..... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
..... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

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