Vital Records Common Library (VRCL) STU2-ballot
2.0.0 - trial-use United States of America flag

Vital Records Common Library (VRCL) STU2-ballot, 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 - Father Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-father-vr Version: 2.0.0
Active as of 2024-03-21 Computable Name: RelatedPersonFatherVitalRecords

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

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 28 Date of Birth (Father)--Edit Flag FAGE_BYPASS birthDate.extension[bypassEditFlag].value codeable ValueSetDateOfBirthEditFlagsVitalRecords,
See Handling of edit flags

Fetal Death
Use Case # Description IJE Name Field Type Value Set/Comments
Fetal Death 28 Date of Birth (Father)--Edit Flag FAGE_BYPASS birthDate.extension[bypassEditFlag].value codeable ValueSetDateOfBirthEditFlagsVitalRecords,
See Handling of edit flags

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 0..*RelatedPersonParentVitalRecordsA person that is related to a patient, but who is not a direct target of care
... relationship 1..*CodeableConceptRelationships describing the father's role relative to the subject.
Binding: Father Relationship Vital Records (required): FatherRelationship

... birthDate
.... extension:bypassEditFlag 0..1ExtensionBypassEditFlagVitalRecordsTo reflect the relevant edit possibilities for Father's date of birth.
..... value[x] 1..1CodeableConceptDOB edit flag

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredValueSetFatherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-father-relationship-vr
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonParentVitalRecordsA 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..1uriA set of rules under which this content was created
... birthPlace 0..1AddressRelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier:SSN Σ0..1IdentifierSSN if available and appropriate to send
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... 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
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(Patient - Vital Records)The patient this person is related to
... relationship SΣC1..*CodeableConceptRelationships describing the father's role relative to the subject.
Binding: Father Relationship Vital Records (required): FatherRelationship


... name SΣC1..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... birthDate SΣ0..1dateThe date on which the related person was born
.... partialDate S0..*(Complex)Provides values of a partial date
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr
.... bypassEditFlag 0..1CodeableConceptTo reflect the relevant edit possibilities for Father's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptDOB edit flag
Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

... address SΣ0..*AddressAddress 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.relationshiprequiredValueSetFatherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-father-relationship-vr
from this IG
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonParentVitalRecordsA 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..1idLogical 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
... birthPlace 0..1AddressRelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... 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
..... id 0..1stringUnique id for inter-element referencing
..... 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 Σ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 ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(Patient - Vital Records)The patient this person is related to
... relationship SΣC1..*CodeableConceptRelationships describing the father's role relative to the subject.
Binding: Father Relationship Vital Records (required): FatherRelationship


... name SΣC1..*HumanNameA name associated with the person
... telecom SΣ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 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
.... partialDate S0..*(Complex)Provides values of a partial date
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr
.... bypassEditFlag 0..1CodeableConceptTo reflect the relevant edit possibilities for Father's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptDOB edit flag
Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

.... 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 0..*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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage 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.relationshiprequiredValueSetFatherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-father-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 0..*RelatedPersonParentVitalRecordsA person that is related to a patient, but who is not a direct target of care
... relationship 1..*CodeableConceptRelationships describing the father's role relative to the subject.
Binding: Father Relationship Vital Records (required): FatherRelationship

... birthDate
.... extension:bypassEditFlag 0..1ExtensionBypassEditFlagVitalRecordsTo reflect the relevant edit possibilities for Father's date of birth.
..... value[x] 1..1CodeableConceptDOB edit flag

doco Documentation for this format

Terminology Bindings (Differential)

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonParentVitalRecordsA 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..1uriA set of rules under which this content was created
... birthPlace 0..1AddressRelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier:SSN Σ0..1IdentifierSSN if available and appropriate to send
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... 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
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(Patient - Vital Records)The patient this person is related to
... relationship SΣC1..*CodeableConceptRelationships describing the father's role relative to the subject.
Binding: Father Relationship Vital Records (required): FatherRelationship


... name SΣC1..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... birthDate SΣ0..1dateThe date on which the related person was born
.... partialDate S0..*(Complex)Provides values of a partial date
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr
.... bypassEditFlag 0..1CodeableConceptTo reflect the relevant edit possibilities for Father's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptDOB edit flag
Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

... address SΣ0..*AddressAddress 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.relationshiprequiredValueSetFatherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-father-relationship-vr
from this IG
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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonParentVitalRecordsA 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..1idLogical 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
... birthPlace 0..1AddressRelatedPerson Birth Place Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... 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
..... id 0..1stringUnique id for inter-element referencing
..... 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 Σ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 ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(Patient - Vital Records)The patient this person is related to
... relationship SΣC1..*CodeableConceptRelationships describing the father's role relative to the subject.
Binding: Father Relationship Vital Records (required): FatherRelationship


... name SΣC1..*HumanNameA name associated with the person
... telecom SΣ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 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
.... partialDate S0..*(Complex)Provides values of a partial date
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr
.... bypassEditFlag 0..1CodeableConceptTo reflect the relevant edit possibilities for Father's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptDOB edit flag
Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

.... 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 0..*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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage 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.relationshiprequiredValueSetFatherRelationshipVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-father-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