HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-status-observation | Version: 2.1.2 | |||
| Active as of 2024-10-30 | Computable Name: USPublicHealthPregnancyStatusObservation | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.67 | ||||
This profile represents current and/or prior pregnancy statuses and their date ranges, enabling investigators to determine if a patient was pregnant, possibly pregnant, not pregnant or whether the pregnancy status was unknown during a particular date range.
The subject of this profile is the mother.
This profile includes the determination method, determination date, and recorded date of the pregnancy status.
Use the effectivePeriod to indicate the date range over which the patient was pregnant/possibly pregnant/not pregnant/unknown. To record the date that the pregnancy status was recorded, use the date-recorded-extension and to record the date on which the pregnancy status determination was made, use the date-determined-extension. If the effectivePeriod.end is not present it is assumed that the date range over which the pregnancy status is asserted is from effectivePeriod.start to the date in the date-recorded-extension. For example, if the effectivePeriod.start has been recorded as two months prior to the date contained in the date-recorded-extension, and there is no effectivePeriod.end recorded, no assumptions can be made about the pregnancy status after the date contained in the date-recorded-extension.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation |
0..* | Observation | US Public Health Pregnancy Status 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/ecr/StructureDefinition/us-ph-date-recorded-extension |
 extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ecr/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 |
 effective[x] |
S | 0..1 | Period | Pregnancy status date range |
| value[x] |
S | 0..1 | CodeableConcept | Pregnancy Status Binding: US Public Health 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:sliceEstimatedGestationalAgeOfPregnancy |
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/ecr/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:sliceEstimatedDateOfDelivery |
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/ecr/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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.value[x] | extensible | USPublicHealthPregnancyStatushttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-pregnancy-statusfrom this IG | |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80 | |
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82 | |
| Observation.component:sliceEstimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | US Public Health Pregnancy Status Observation 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/ecr/StructureDefinition/us-ph-date-recorded-extension |
| extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-date-determined-extension |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| 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 | 0..1 | CodeableConcept | Pregnancy Status Binding: US Public Health 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:sliceEstimatedGestationalAgeOfPregnancy |
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/ecr/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:sliceEstimatedDateOfDelivery |
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/ecr/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) |
| 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.code | example | Pattern: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.value[x] | extensible | USPublicHealthPregnancyStatushttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-pregnancy-statusfrom this IG | |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80 | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82 | |
| Observation.component:sliceEstimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81 |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | US Public Health Pregnancy Status Observation 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.
| |||||
| 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/ecr/StructureDefinition/us-ph-date-recorded-extension | ||||
| extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ecr/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 | 0..1 | CodeableConcept | Pregnancy Status Binding: US Public Health 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:sliceEstimatedGestationalAgeOfPregnancy |
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/ecr/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:sliceEstimatedDateOfDelivery |
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/ecr/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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://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.code | example | Pattern: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.value[x] | extensible | USPublicHealthPregnancyStatushttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-pregnancy-statusfrom this IG | ||||
| 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 | ||||
| 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:sliceEstimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82 | ||||
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:sliceEstimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81 | ||||
| Observation.component:sliceEstimatedDateOfDelivery.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:sliceEstimatedDateOfDelivery.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 Observation
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
0..* | Observation | US Public Health Pregnancy Status 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/ecr/StructureDefinition/us-ph-date-recorded-extension |
| extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ecr/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 |
| effective[x] |
S | 0..1 | Period | Pregnancy status date range |
| value[x] |
S | 0..1 | CodeableConcept | Pregnancy Status Binding: US Public Health 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:sliceEstimatedGestationalAgeOfPregnancy |
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/ecr/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:sliceEstimatedDateOfDelivery |
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/ecr/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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.value[x] | extensible | USPublicHealthPregnancyStatushttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-pregnancy-statusfrom this IG | |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80 | |
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82 | |
| Observation.component:sliceEstimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | US Public Health Pregnancy Status Observation 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/ecr/StructureDefinition/us-ph-date-recorded-extension |
| extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-date-determined-extension |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| 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 | 0..1 | CodeableConcept | Pregnancy Status Binding: US Public Health 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:sliceEstimatedGestationalAgeOfPregnancy |
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/ecr/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:sliceEstimatedDateOfDelivery |
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/ecr/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) |
| 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.code | example | Pattern: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.value[x] | extensible | USPublicHealthPregnancyStatushttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-pregnancy-statusfrom this IG | |
| Observation.method | extensible | PregnancyStatusDeterminationMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.80 | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82 | |
| Observation.component:sliceEstimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81 |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | US Public Health Pregnancy Status Observation 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.
| |||||
| 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/ecr/StructureDefinition/us-ph-date-recorded-extension | ||||
| extensionPregnancyStatusDeterminationDate |
S | 0..1 | dateTime | Pregnancy Status Determination Date URL: http://hl7.org/fhir/us/ecr/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 | 0..1 | CodeableConcept | Pregnancy Status Binding: US Public Health 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:sliceEstimatedGestationalAgeOfPregnancy |
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/ecr/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:sliceEstimatedDateOfDelivery |
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/ecr/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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://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.code | example | Pattern: LOINC Code 82810-3http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.value[x] | extensible | USPublicHealthPregnancyStatushttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-pregnancy-statusfrom this IG | ||||
| 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 | ||||
| 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:sliceEstimatedGestationalAgeOfPregnancy.code | extensible | EstimatedGestationalAgeCodeIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.82 | ||||
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:sliceEstimatedGestationalAgeOfPregnancy.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:sliceEstimatedDateOfDelivery.code | extensible | EstimatedDateOfDeliveryIncludingMethod http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.81 | ||||
| Observation.component:sliceEstimatedDateOfDelivery.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:sliceEstimatedDateOfDelivery.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 Observation
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Public Health. Package hl7.fhir.us.ecr#2.1.2 based on FHIR 4.0.1. Generated 2024-10-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change