International Patient Summary Implementation Guide
1.0.0 - STU 1

This page is part of the International Patient Summary Implementation Guide (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: ObservationPregnancyStatusUvIps

This profile constrains the Observation resource to represent the pregnancy status.

The official URL for this profile is: 

http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips

Formal Views of Profile Content

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

This structure is derived from Observation

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*ObservationMeasurements and simple assertions
... code S1..1CodeableConceptIPSConcept - reference to a terminology or just text
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
... subject S1..1Reference(Patient (IPS))Who and/or what the observation is about
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] S1..1dateTimeClinically relevant time/time-period for observation
.... data-absent-reason S0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... bodySite 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... hasMember S0..*Reference(Observation (Pregnancy: EDD))Expected Delivery Date
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... component 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*ObservationMeasurements and simple assertions
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SI1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: LOINCCodes (example)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣI1..1Reference(Patient (IPS))Who and/or what the observation is about
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1dateTimeClinically relevant time/time-period for observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... data-absent-reason SI0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... value 0..1dateTimePrimitive value for dateTime
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1(Slice Definition)Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueCodeableConcept SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Pregnancy Status - IPS (required)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... hasMember SΣI0..*Reference(Observation (Pregnancy: EDD))Expected Delivery Date
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from

doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*ObservationMeasurements and simple assertions
... code S1..1CodeableConceptIPSConcept - reference to a terminology or just text
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
... subject S1..1Reference(Patient (IPS))Who and/or what the observation is about
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] S1..1dateTimeClinically relevant time/time-period for observation
.... data-absent-reason S0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... bodySite 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... hasMember S0..*Reference(Observation (Pregnancy: EDD))Expected Delivery Date
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*ObservationMeasurements and simple assertions
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SI1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: LOINCCodes (example)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 82810-3
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣI1..1Reference(Patient (IPS))Who and/or what the observation is about
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1dateTimeClinically relevant time/time-period for observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... data-absent-reason SI0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... value 0..1dateTimePrimitive value for dateTime
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1(Slice Definition)Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueCodeableConcept SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Pregnancy Status - IPS (required)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... hasMember SΣI0..*Reference(Observation (Pregnancy: EDD))Expected Delivery Date
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexamplePattern: LOINC code 82810-3
Observation.subject.typeextensibleResourceType
Observation.value[x]:valueCodeableConceptrequiredPregnancyStatusUvIps
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.hasMember.typeextensibleResourceType
Observation.component.codeexampleLOINCCodes
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ObservationIf 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-4ObservationIf 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-5ObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ObservationA resource should have narrative for robust management
: text.`div`.exists()
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7ObservationIf 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()
ele-1Observation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subject.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.subject.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.subject.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subject.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subject.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subject.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.effective[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.effective[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMember.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.hasMember.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.hasMember.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMember.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMember.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMember.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())