Vital Records Common Profiles Library
1.0.0 - STU 1

This page is part of the Vital Records Common Profile Library (v1.0.0: STU 1 on FHIR R4) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: RelatedPerson - Mother Gestational

Defining URL:http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-mother-gestational
Version:1.0.0
Name:RelatedPersonMotherGestational
Title:RelatedPerson - Mother Gestational
Status:Active as of 2021-10-12T12:41:40+00:00
Definition:

The woman who gave birth to, or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.

Publisher:HL7 International - Public Health Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-mother-gestational

Formal Views of Profile Content

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

This structure is derived from RelatedPersonMother

Summary

Mandatory: 1 element

This structure is derived from RelatedPersonMother

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonMotherThe woman who gave birth to, or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.
... relationship 1..1CodeableConceptgestataional mother
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://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: GESTM

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonMotherThe woman who gave birth to, or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-relatedperson-deceased S0..1boolean, dateTimeExtension
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased
... Extension-relatedperson-birthplace S0..1AddressExtension
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace
... us-core-race S1..1(Complex)If race is unknown, use UNK from the bound value set.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S1..1(Complex)If ethnicity is unknown omit both coded data fields.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:SSN SΣ0..1IdentifierSSN if available and appropriate to send
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(Patient - Child | Patient - Decedent Fetus)The patient this person is related to
... relationship SΣ1..1CodeableConceptgestataional mother
Binding: Mother Relationship (required): MotherRelationship



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://terminology.hl7.org/CodeSystem/v3-RoleCode
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: GESTM
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... name SΣ1..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date on which the related person was born
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Extension-date-part-absent-reason S0..*(Complex)Indicates reason for missing birthDate data.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-date-part-absent-reason
.... value 0..1datePrimitive value for date
... address SΣ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication S0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonMotherThe woman who gave birth to, or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.
... Extension-relatedperson-deceased 0..1boolean, dateTimeExtension
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased
... Extension-relatedperson-birthplace 0..1AddressExtension
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace
... us-core-race 1..1(Complex)If race is unknown, use UNK from the bound value set.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... Slices for identifier Σ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:SSN Σ0..1IdentifierSSN if available and appropriate to send
..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
... patient Σ1..1Reference(Patient - Child | Patient - Decedent Fetus)The patient this person is related to
... relationship Σ1..1CodeableConceptgestataional mother
Binding: Mother Relationship (required): MotherRelationship



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://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: GESTM
... name Σ1..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
.... Extension-date-part-absent-reason 0..*(Complex)Indicates reason for missing birthDate data.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-date-part-absent-reason
... address Σ0..*AddressAddress where the related person can be contacted or visited
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health

doco Documentation for this format

This structure is derived from RelatedPersonMother

Summary

Mandatory: 1 element

Differential View

This structure is derived from RelatedPersonMother

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonMotherThe woman who gave birth to, or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.
... relationship 1..1CodeableConceptgestataional mother
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://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: GESTM

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonMotherThe woman who gave birth to, or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-relatedperson-deceased S0..1boolean, dateTimeExtension
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased
... Extension-relatedperson-birthplace S0..1AddressExtension
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace
... us-core-race S1..1(Complex)If race is unknown, use UNK from the bound value set.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S1..1(Complex)If ethnicity is unknown omit both coded data fields.
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:SSN SΣ0..1IdentifierSSN if available and appropriate to send
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(Patient - Child | Patient - Decedent Fetus)The patient this person is related to
... relationship SΣ1..1CodeableConceptgestataional mother
Binding: Mother Relationship (required): MotherRelationship



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://terminology.hl7.org/CodeSystem/v3-RoleCode
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: GESTM
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... name SΣ1..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date on which the related person was born
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Extension-date-part-absent-reason S0..*(Complex)Indicates reason for missing birthDate data.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-date-part-absent-reason
.... value 0..1datePrimitive value for date
... address SΣ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication S0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
RelatedPerson.languagepreferredCommonLanguages
Max Binding: AllLanguages
RelatedPerson.identifier:SSN.userequiredIdentifierUse
RelatedPerson.identifier:SSN.typeextensiblePattern: SS
RelatedPerson.relationshiprequiredPattern: GESTM
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdPathDetailsRequirements
dom-2RelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3RelatedPersonIf 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-4RelatedPersonIf 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-5RelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6RelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1RelatedPerson.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.extension:deceasedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.extension:deceasedMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.extension:birthPlaceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.extension:birthPlaceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.extension:raceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.extension:raceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.extension:ethnicityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.extension:ethnicityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSNAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSN.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.identifier:SSN.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.identifier:SSN.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSN.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSN.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSN.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSN.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.identifier:SSN.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.birthDate.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.birthDate.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.birthDate.extension:datePartAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.birthDate.extension:datePartAbsentReasonMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())