US Public Health Profiles Library
2.0.0-ballot - STU 2 - Ballot
US Public Health Profiles Library
2.0.0-ballot - STU 2 - Ballot
This page is part of the US Public Health Profiles Library (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-pregnancy-status-observation | Version: 2.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: USPublicHealthPregnancyStatusObservation | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.46 | ||||
This profile represents pregnancy status, enabling investigators to determine if a patient was pregnant, possibly pregnant, not pregnant or whether the pregnancy status was unknown at a given point in time.
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 effectiveDateTime to record the date that the pregnancy status was observed and to record the date on which the pregnancy status determination was made, use the date-determined-extension.
It is based on the US Core Observation Pregnancy Status Profile profile and further constrains it as follows:
| Use Case | Data Class | Data Element Name |
|---|---|---|
| Case Reporting | Health Status Assessments/Pregnancy Information | Pregnancy Status |
| Case Reporting | Pregnancy Information | Estimated Date of Delivery |
| Case Reporting | Pregnancy Information | Estimated Date of Delivery Determination Methhod |
| Case Reporting | Pregnancy Information | Gestational Age |
| Case Reporting | Pregnancy Information | Gestational Age Determination Date |
| Case Reporting | Pregnancy Information | Gestational Age Determination Method |
| Case Reporting | Pregnancy Information | Pregnancy Status Determination Method |
| Case Reporting | Pregnancy Information | Pregnancy Status Recorded Date |
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Observation |
C | 0..* | USCoreObservationPregnancyStatusProfile | US Public Health Pregnancy Status Observation Constraints: obs-6, obs-7 |
  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 |
   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 |
| status |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
 Slices for category |
S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
 category:SocialHistory |
S | 0..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. 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://terminology.hl7.org/CodeSystem/observation-category | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
| 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 | |
| code |
SΣ | 1..1 | CodeableConcept | (USCDI) Pregnancy Status 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) | (USCDI) Who and/or what the observation is about |
| Slices for effective[x] |
Σ | 1..1 | dateTime | (USCDI+) Pregnancy Status Recorded Date Slice: Unordered, Closed by type:$this |
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation |
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | (USCDI+) Pregnancy Status Slice: Unordered, Closed by type:$this |
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | (USCDI) Coded Responses from Pregnancy Status Value Set Binding: US Core Pregnancy Status Codes (preferred) |
| method |
S | 0..1 | CodeableConcept | (USCDI+) Pregnancy Status Determination Method Binding: PregnancyStatusDeterminationMethod (20240607)  (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 and related data |
| extension |
S | 0..1 | dateTime | (USCDI+) Gestational Age 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 | (USCDI+) Gestational Age Determination Method (code includes method, if known) Binding: EstimatedGestationalAgeCodeIncludingMethod (20240608) (extensible): Estimated Gestational Age Code Including Method |
 value[x] |
SΣ | 1..1 | Quantity | (USCDI+) Gestational Age (estimated - 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 | |
| component:estimatedDateOfDelivery |
SΣ | 0..* | BackboneElement | Estimated Date of Delivery (EDD) and releated data |
| 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 | (USCDI+) Estimated Date of Delivery Determination Method (code includes method, if known) Binding: EstimatedDateOfDeliveryIncludingMethod (20240608) (extensible): Estimated Date of Delivery Including Method |
| value[x] |
SΣ | 1..1 | dateTime | (USCDI+) Estimated Date of Delivery (EDD) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.code | example | Pattern Value: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept | preferred | USCorePregnancyStatusCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-pregnancy-status | |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80|20240607 | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.component:estimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82|20240608 | |
| Observation.component:estimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81|20240608 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If 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() |
This structure is derived from USCoreObservationPregnancyStatusProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | USCoreObservationPregnancyStatusProfile | US Public Health Pregnancy Status Observation | |
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension |
| subject |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |
| effective[x] |
1..1 | dateTime | (USCDI+) Pregnancy Status Recorded Date | |
| value[x] |
1..1 | CodeableConcept | (USCDI+) Pregnancy Status | |
| method |
S | 0..1 | CodeableConcept | (USCDI+) Pregnancy Status Determination Method Binding: PregnancyStatusDeterminationMethod (20240607) (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 and related data |
| extension |
S | 0..1 | dateTime | (USCDI+) Gestational Age Determination Date URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension |
| code |
S | 1..1 | CodeableConcept | (USCDI+) Gestational Age Determination Method (code includes method, if known) Binding: EstimatedGestationalAgeCodeIncludingMethod (20240608) (extensible): Estimated Gestational Age Code Including Method |
| value[x] |
S | 1..1 | Quantity | (USCDI+) Gestational Age (estimated - 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) and releated data |
| 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 | (USCDI+) Estimated Date of Delivery Determination Method (code includes method, if known) Binding: EstimatedDateOfDeliveryIncludingMethod (20240608) (extensible): Estimated Date of Delivery Including Method |
| value[x] |
S | 1..1 | dateTime | (USCDI+) Estimated Date of Delivery (EDD) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80|20240607 | |
| Observation.component:estimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82|20240608 | |
| Observation.component:estimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81|20240608 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | USCoreObservationPregnancyStatusProfile | US Public Health Pregnancy Status Observation Constraints: obs-6, obs-7 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| 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 |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| Slices for category |
S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| category:SocialHistory |
S | 0..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. 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://terminology.hl7.org/CodeSystem/observation-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||
| 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 | |||||
| code |
SΣ | 1..1 | CodeableConcept | (USCDI) Pregnancy Status 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) | (USCDI) 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 | ||||
| Slices for effective[x] |
Σ | 1..1 | dateTime | (USCDI+) Pregnancy Status Recorded Date Slice: Unordered, Closed by type:$this | ||||
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation | ||||
| 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 | ||||
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | (USCDI+) Pregnancy Status Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | (USCDI) Coded Responses from Pregnancy Status Value Set Binding: US Core Pregnancy Status Codes (preferred) | ||||
| 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 | (USCDI+) Pregnancy Status Determination Method Binding: PregnancyStatusDeterminationMethod (20240607) (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 Constraints: obs-3 | ||||
| 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 and related data | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
S | 0..1 | dateTime | (USCDI+) Gestational Age 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 | (USCDI+) Gestational Age Determination Method (code includes method, if known) Binding: EstimatedGestationalAgeCodeIncludingMethod (20240608) (extensible): Estimated Gestational Age Code Including Method | ||||
| value[x] |
SΣ | 1..1 | Quantity | (USCDI+) Gestational Age (estimated - 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) and releated data | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| 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 | (USCDI+) Estimated Date of Delivery Determination Method (code includes method, if known) Binding: EstimatedDateOfDeliveryIncludingMethod (20240608) (extensible): Estimated Date of Delivery Including Method | ||||
| value[x] |
SΣ | 1..1 | dateTime | (USCDI+) Estimated Date of Delivery (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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.code | example | Pattern Value: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept | preferred | USCorePregnancyStatusCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-pregnancy-status | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80|20240607 | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.component:estimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82|20240608 | ||||
| Observation.component:estimatedGestationalAgeOfPregnancy.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component:estimatedGestationalAgeOfPregnancy.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.component:estimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81|20240608 | ||||
| Observation.component:estimatedDateOfDelivery.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component:estimatedDateOfDelivery.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If 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() |
This structure is derived from USCoreObservationPregnancyStatusProfile
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | USCoreObservationPregnancyStatusProfile | US Public Health Pregnancy Status Observation Constraints: obs-6, obs-7 |
| 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 |
| 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 |
| status |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| Slices for category |
S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
| category:SocialHistory |
S | 0..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. 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://terminology.hl7.org/CodeSystem/observation-category | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
| 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 | |
| code |
SΣ | 1..1 | CodeableConcept | (USCDI) Pregnancy Status 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) | (USCDI) Who and/or what the observation is about |
| Slices for effective[x] |
Σ | 1..1 | dateTime | (USCDI+) Pregnancy Status Recorded Date Slice: Unordered, Closed by type:$this |
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation |
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | (USCDI+) Pregnancy Status Slice: Unordered, Closed by type:$this |
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | (USCDI) Coded Responses from Pregnancy Status Value Set Binding: US Core Pregnancy Status Codes (preferred) |
| method |
S | 0..1 | CodeableConcept | (USCDI+) Pregnancy Status Determination Method Binding: PregnancyStatusDeterminationMethod (20240607) (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 and related data |
| extension |
S | 0..1 | dateTime | (USCDI+) Gestational Age 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 | (USCDI+) Gestational Age Determination Method (code includes method, if known) Binding: EstimatedGestationalAgeCodeIncludingMethod (20240608) (extensible): Estimated Gestational Age Code Including Method |
| value[x] |
SΣ | 1..1 | Quantity | (USCDI+) Gestational Age (estimated - 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 | |
| component:estimatedDateOfDelivery |
SΣ | 0..* | BackboneElement | Estimated Date of Delivery (EDD) and releated data |
| 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 | (USCDI+) Estimated Date of Delivery Determination Method (code includes method, if known) Binding: EstimatedDateOfDeliveryIncludingMethod (20240608) (extensible): Estimated Date of Delivery Including Method |
| value[x] |
SΣ | 1..1 | dateTime | (USCDI+) Estimated Date of Delivery (EDD) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.code | example | Pattern Value: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept | preferred | USCorePregnancyStatusCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-pregnancy-status | |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80|20240607 | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.component:estimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82|20240608 | |
| Observation.component:estimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81|20240608 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If 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() |
Differential View
This structure is derived from USCoreObservationPregnancyStatusProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | USCoreObservationPregnancyStatusProfile | US Public Health Pregnancy Status Observation | |
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension |
| subject |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |
| effective[x] |
1..1 | dateTime | (USCDI+) Pregnancy Status Recorded Date | |
| value[x] |
1..1 | CodeableConcept | (USCDI+) Pregnancy Status | |
| method |
S | 0..1 | CodeableConcept | (USCDI+) Pregnancy Status Determination Method Binding: PregnancyStatusDeterminationMethod (20240607) (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 and related data |
| extension |
S | 0..1 | dateTime | (USCDI+) Gestational Age Determination Date URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-date-determined-extension |
| code |
S | 1..1 | CodeableConcept | (USCDI+) Gestational Age Determination Method (code includes method, if known) Binding: EstimatedGestationalAgeCodeIncludingMethod (20240608) (extensible): Estimated Gestational Age Code Including Method |
| value[x] |
S | 1..1 | Quantity | (USCDI+) Gestational Age (estimated - 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) and releated data |
| 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 | (USCDI+) Estimated Date of Delivery Determination Method (code includes method, if known) Binding: EstimatedDateOfDeliveryIncludingMethod (20240608) (extensible): Estimated Date of Delivery Including Method |
| value[x] |
S | 1..1 | dateTime | (USCDI+) Estimated Date of Delivery (EDD) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80|20240607 | |
| Observation.component:estimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82|20240608 | |
| Observation.component:estimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81|20240608 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | USCoreObservationPregnancyStatusProfile | US Public Health Pregnancy Status Observation Constraints: obs-6, obs-7 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| 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 |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| Slices for category |
S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| category:SocialHistory |
S | 0..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. 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://terminology.hl7.org/CodeSystem/observation-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||
| 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 | |||||
| code |
SΣ | 1..1 | CodeableConcept | (USCDI) Pregnancy Status 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) | (USCDI) 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 | ||||
| Slices for effective[x] |
Σ | 1..1 | dateTime | (USCDI+) Pregnancy Status Recorded Date Slice: Unordered, Closed by type:$this | ||||
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation | ||||
| 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 | ||||
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | (USCDI+) Pregnancy Status Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | (USCDI) Coded Responses from Pregnancy Status Value Set Binding: US Core Pregnancy Status Codes (preferred) | ||||
| 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 | (USCDI+) Pregnancy Status Determination Method Binding: PregnancyStatusDeterminationMethod (20240607) (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 Constraints: obs-3 | ||||
| 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 and related data | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
S | 0..1 | dateTime | (USCDI+) Gestational Age 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 | (USCDI+) Gestational Age Determination Method (code includes method, if known) Binding: EstimatedGestationalAgeCodeIncludingMethod (20240608) (extensible): Estimated Gestational Age Code Including Method | ||||
| value[x] |
SΣ | 1..1 | Quantity | (USCDI+) Gestational Age (estimated - 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) and releated data | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| 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 | (USCDI+) Estimated Date of Delivery Determination Method (code includes method, if known) Binding: EstimatedDateOfDeliveryIncludingMethod (20240608) (extensible): Estimated Date of Delivery Including Method | ||||
| value[x] |
SΣ | 1..1 | dateTime | (USCDI+) Estimated Date of Delivery (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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.code | example | Pattern Value: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept | preferred | USCorePregnancyStatusCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-pregnancy-status | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80|20240607 | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.component:estimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82|20240608 | ||||
| Observation.component:estimatedGestationalAgeOfPregnancy.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component:estimatedGestationalAgeOfPregnancy.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.component:estimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81|20240608 | ||||
| Observation.component:estimatedDateOfDelivery.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component:estimatedDateOfDelivery.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If 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() |
This structure is derived from USCoreObservationPregnancyStatusProfile
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health. Package hl7.fhir.us.ph-library#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-07-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change