Vital Records Common Library (VRCL) FHIR Implementation Guide
2.0.0 - STU2 United States of America flag

Vital Records Common Library (VRCL) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions

Resource Profile: RelatedPerson - Mother Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-mother-vr Version: 2.0.0
Active as of 2024-09-16 Computable Name: RelatedPersonMotherVitalRecords

The mother of the report subject. Different individuals may play different roles as the mother (e.g., biological mother, adoptive mother, etc.). This profile is designed to supplant the similar profile in VRDR

Usage:

Formal Views of Profile Content

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

This structure is derived from RelatedPersonParentVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson RelatedPersonParentVitalRecords
... relationship 1..* CodeableConcept Relationships describing the mother's role relative to the subject.
Binding: Value Set - Mother Relationship Vital Records (required): MotherRelationship

... gender 0..1 code Gender
... birthDate
.... Slices for extension Content/Rules for all slices
..... extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords To reflect the relevant edit possibilities for Mother's date of birth.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredValueSetMotherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mother-relationship-vr
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPersonParentVitalRecords A person that is related to a patient, but who is not a direct target of care
us-core-14: Either a name or a relationship SHALL be provided (or both)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... birthPlace 0..1 Address RelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:SSN Σ 0..1 Identifier SSN if available and appropriate to send
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(Patient - Vital Records) The patient this person is related to
... relationship SΣC 1..* CodeableConcept Relationships describing the mother's role relative to the subject.
Binding: Value Set - Mother Relationship Vital Records (required): MotherRelationship


... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... address SΣ 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshiprequiredValueSetMotherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mother-relationship-vr
from this IG
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPersonParentVitalRecords A person that is related to a patient, but who is not a direct target of care
us-core-14: Either a name or a relationship SHALL be provided (or both)
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 Address RelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:SSN Σ 0..1 Identifier SSN if available and appropriate to send
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... 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
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(Patient - Vital Records) The patient this person is related to
... relationship SΣC 1..* CodeableConcept Relationships describing the mother's role relative to the subject.
Binding: Value Set - Mother Relationship Vital Records (required): MotherRelationship


... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... partialDate 0..* (Complex) Provides values of a partial date
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr
..... bypassEditFlag 0..1 (Complex) To reflect the relevant edit possibilities for Mother's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for date of birth.
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

.... value 0..1 date Primitive value for date
... address SΣ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... 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
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshiprequiredValueSetMotherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mother-relationship-vr
from this IG
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.birthDate.extension:bypassEditFlag.value[x]requiredValueSetDateOfBirthEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
from this IG
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from RelatedPersonParentVitalRecords

Summary

Differential View

This structure is derived from RelatedPersonParentVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson RelatedPersonParentVitalRecords
... relationship 1..* CodeableConcept Relationships describing the mother's role relative to the subject.
Binding: Value Set - Mother Relationship Vital Records (required): MotherRelationship

... gender 0..1 code Gender
... birthDate
.... Slices for extension Content/Rules for all slices
..... extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords To reflect the relevant edit possibilities for Mother's date of birth.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredValueSetMotherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mother-relationship-vr
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPersonParentVitalRecords A person that is related to a patient, but who is not a direct target of care
us-core-14: Either a name or a relationship SHALL be provided (or both)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... birthPlace 0..1 Address RelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:SSN Σ 0..1 Identifier SSN if available and appropriate to send
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(Patient - Vital Records) The patient this person is related to
... relationship SΣC 1..* CodeableConcept Relationships describing the mother's role relative to the subject.
Binding: Value Set - Mother Relationship Vital Records (required): MotherRelationship


... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... address SΣ 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshiprequiredValueSetMotherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mother-relationship-vr
from this IG
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPersonParentVitalRecords A person that is related to a patient, but who is not a direct target of care
us-core-14: Either a name or a relationship SHALL be provided (or both)
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 Address RelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:SSN Σ 0..1 Identifier SSN if available and appropriate to send
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... 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
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(Patient - Vital Records) The patient this person is related to
... relationship SΣC 1..* CodeableConcept Relationships describing the mother's role relative to the subject.
Binding: Value Set - Mother Relationship Vital Records (required): MotherRelationship


... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... partialDate 0..* (Complex) Provides values of a partial date
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr
..... bypassEditFlag 0..1 (Complex) To reflect the relevant edit possibilities for Mother's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for date of birth.
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

.... value 0..1 date Primitive value for date
... address SΣ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... 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
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshiprequiredValueSetMotherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mother-relationship-vr
from this IG
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.birthDate.extension:bypassEditFlag.value[x]requiredValueSetDateOfBirthEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
from this IG
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from RelatedPersonParentVitalRecords

Summary

 

Other representations of profile: CSV, Excel, Schematron