International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.27--20200714163153 | Version: 1.1.0-ballot | |||
Draft as of 2020-07-14 | Computable Name: IPSPregnancyStatusObservation | |||
Other Identifiers: OID:2.16.840.1.113883.10.22.4.27 (use: official, ) |
A pregnancy status observation records whether the patient is currently pregnant or not. If pregnant, an Expected Delivery Date may be specified as an subordinate observation.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Path | Conformance | ValueSet | URI |
Observation.value | required | Pregnancy_status_uv_ipshttp://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips from this IG |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | S | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.27 | |
@classCode | 1..1 | cs | Binding: CDAActClassObservation (required) | |
@moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) | |
code | S | 1..1 | CD | Binding: ObservationType (example) |
@code | 0..1 | cs | Fixed Value: 82810-3 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
statusCode | S | 1..1 | CS | Binding: ActStatus (required) |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
value | S | 1..1 | Binding: IPS Pregnancy Status (required): IPS Pregnancy Status | |
value | ANY | |||
value | BL | |||
value | ED | |||
value | ST | |||
value | CD | |||
value | CV | |||
value | CE | |||
value | CO | |||
value | SC | |||
value | II | |||
value | TEL | |||
value | AD | |||
value | EN | |||
value | INT | |||
value | REAL | |||
value | PQ | |||
value | MO | |||
value | TS | |||
value | IVL_PQ | |||
value | IVL_TS | |||
value | PIVL_TS | |||
value | EIVL_TS | |||
value | SXPR_TS | |||
value | RTO_PQ_PQ | |||
Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:profile | |
entryRelationship:entryRelationship-1 | SC | 0..1 | EntryRelationship | entryRelationship-1: contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) |
@typeCode | 1..1 | code | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
Slices for observation | Content/Rules for all slices | |||
observation:entryRelationship-1 | S | 1..1 | IPSPregnancyExpectedDeliveryDateObservation | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.value | required | Pregnancy_status_uv_ipshttp://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips from this IG | |
Observation.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) : |
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Observation.value | required | Pregnancy_status_uv_ipshttp://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips from this IG | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.entryRelationship:entryRelationship-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:entryRelationship-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) : |
This structure is derived from Observation
Summary
Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Path | Conformance | ValueSet | URI |
Observation.value | required | Pregnancy_status_uv_ipshttp://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips from this IG |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | S | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.27 | |
@classCode | 1..1 | cs | Binding: CDAActClassObservation (required) | |
@moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) | |
code | S | 1..1 | CD | Binding: ObservationType (example) |
@code | 0..1 | cs | Fixed Value: 82810-3 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
statusCode | S | 1..1 | CS | Binding: ActStatus (required) |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
value | S | 1..1 | Binding: IPS Pregnancy Status (required): IPS Pregnancy Status | |
value | ANY | |||
value | BL | |||
value | ED | |||
value | ST | |||
value | CD | |||
value | CV | |||
value | CE | |||
value | CO | |||
value | SC | |||
value | II | |||
value | TEL | |||
value | AD | |||
value | EN | |||
value | INT | |||
value | REAL | |||
value | PQ | |||
value | MO | |||
value | TS | |||
value | IVL_PQ | |||
value | IVL_TS | |||
value | PIVL_TS | |||
value | EIVL_TS | |||
value | SXPR_TS | |||
value | RTO_PQ_PQ | |||
Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:profile | |
entryRelationship:entryRelationship-1 | SC | 0..1 | EntryRelationship | entryRelationship-1: contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) |
@typeCode | 1..1 | code | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
Slices for observation | Content/Rules for all slices | |||
observation:entryRelationship-1 | S | 1..1 | IPSPregnancyExpectedDeliveryDateObservation | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.value | required | Pregnancy_status_uv_ipshttp://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips from this IG | |
Observation.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) : |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Observation.value | required | Pregnancy_status_uv_ipshttp://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips from this IG | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.entryRelationship:entryRelationship-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:entryRelationship-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2024-08-04) : |
This structure is derived from Observation
Summary
Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: