Vital Records Common Profiles Library
1.1.0 - STU 1.1
Vital Records Common Profiles Library
1.1.0 - STU 1.1
This page is part of the Vital Records Common Profile Library (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-father-natural-vr | Version: 1.1.0 | |||
| Active as of 2023-10-06 | Computable Name: RelatedPersonFatherNaturalVitalRecords | |||
This RelatedPerson profile represents the biological (natural) father of the newborn or fetus.
This profile is mapped to:
| Use Case | IJE Field# | Description | IJE Name | Field |
|---|---|---|---|---|
| Natality | 279 | Father’s Social Security Number | DAD_SSN | identifier[type=SS] |
| Natality | 274 | Father’s First Name | DADFNAME | name.given , name.use = official |
| Natality | 276 | Father’s Last Name | DADLNAME | name.family |
| Natality | 275 | Father’s Middle Name | DADMNAME | name.given |
| Natality | 277 | Father’s Surname Suffix | DADSUFFX | name.suffix |
| Natality | 290 | State, U.S. Territory or Canadian Province of Birth (Father) - code | FBPLACD_ST_TER_C | extension:Extension-relatedperson-birthplace-vr |
| Natality | 291 | Father’s Country of Birth (Code) | FBPLACE_CNT_C | extension:Extension-relatedperson-birthplace-vr |
| Natality | 308 | Father’s Country of Birth (Literal) | FBPLACE_CNTRY_TXT | extension:Extension-relatedperson-birthplace-vr |
| Natality | 307 | State, U.S. Territory or Canadian Province of Birth (Father) - literal | FBPLACE_ST_TER_TXT | extension:Extension-relatedperson-birthplace-vr |
| Natality | 27 | Date of Birth (Father)–Day | FDOB_DY | birthDate |
| Natality | 26 | Date of Birth (Father)–Month | FDOB_MO | birthDate |
| Natality | 25 | Date of Birth (Father)–Year | FDOB_YR | birthDate |
| Natality | 80 | Father of Hispanic Origin?–Mexican | FETHNIC1 | extension:us-core-ethnicity |
| Natality | 81 | Father of Hispanic Origin?–Puerto Rican | FETHNIC2 | extension:us-core-ethnicity |
| Natality | 82 | Father of Hispanic Origin?–Cuban | FETHNIC3 | extension:us-core-ethnicity |
| Natality | 83 | Father of Hispanic Origin?–Other | FETHNIC4 | extension:us-core-ethnicity |
| Natality | 84 | Father of Hispanic Origin?–Other Literal | FETHNIC5 | extension:us-core-ethnicity |
| Natality | 85 | Father’s Race–White | FRACE1 | extension:us-core-race |
| Natality | 94 | Father’s Race–Other Asian | FRACE10 | extension:us-core-race |
| Natality | 95 | Father’s Race–Native Hawaiian | FRACE11 | extension:us-core-race |
| Natality | 96 | Father’s Race–Guamanian or Chamorro | FRACE12 | extension:us-core-race |
| Natality | 97 | Father’s Race–Samoan | FRACE13 | extension:us-core-race |
| Natality | 98 | Father’s Race–Other Pacific Islander | FRACE14 | extension:us-core-race |
| Natality | 99 | Father’s Race–Other | FRACE15 | extension:us-core-race |
| Natality | 100 | Father’s Race–First American Indian or Alaska Native Literal | FRACE16 | extension:us-core-race |
| Natality | 101 | Father’s Race–Second American Indian or Alaska Native Literal | FRACE17 | extension:us-core-race |
| Natality | 102 | Father’s Race–First Other Asian Literal | FRACE18 | extension:us-core-race |
| Natality | 103 | Father’s Race–Second Other Asian Literal | FRACE19 | extension:us-core-race |
| Natality | 86 | Father’s Race–Black or African American | FRACE2 | extension:us-core-race |
| Natality | 104 | Father’s Race–First Other Pacific Islander Literal | FRACE20 | extension:us-core-race |
| Natality | 105 | Father’s Race–Second Other Pacific Islander Literal | FRACE21 | extension:us-core-race |
| Natality | 106 | Father’s Race–First Other Literal | FRACE22 | extension:us-core-race |
| Natality | 107 | Father’s Race–Second Other Literal | FRACE23 | extension:us-core-race |
| Natality | 87 | Father’s Race–American Indian or Alaska Native | FRACE3 | extension:us-core-race |
| Natality | 88 | Father’s Race–Asian Indian | FRACE4 | extension:us-core-race |
| Natality | 89 | Father’s Race–Chinese | FRACE5 | extension:us-core-race |
| Natality | 90 | Father’s Race–Filipino | FRACE6 | extension:us-core-race |
| Natality | 91 | Father’s Race–Japanese | FRACE7 | extension:us-core-race |
| Natality | 92 | Father’s Race–Korean | FRACE8 | extension:us-core-race |
| Natality | 93 | Father’s Race–Vietnamese | FRACE9 | extension:us-core-race |
| Fetal Death | 266 | Father’s Social Security Number | DAD_SSN | identifier[type=SS] |
| Fetal Death | 261 | Father’s Legal First Name | DADFNAME | name.given , name.use = official |
| Fetal Death | 263 | Father’s Legal Last Name | DADLNAME | name.family |
| Fetal Death | 262 | Father’s Legal Middle Name | DADMNAME | name.given |
| Fetal Death | 264 | Father’s Legal Surname Suffix | DADSUFFIX | name.suffix |
| Fetal Death | 27 | Date of Birth (Father)–Day | FDOB_DY | birthDate |
| Fetal Death | 26 | Date of Birth (Father)–Month | FDOB_MO | birthDate |
| Fetal Death | 25 | Date of Birth (Father)–Year | FDOB_YR | birthDate |
| Fetal Death | 285 | Father of Hispanic Origin?–Mexican | FETHNIC1 | extension:us-core-ethnicity |
| Fetal Death | 286 | Father of Hispanic Origin?–Puerto Rican | FETHNIC2 | extension:us-core-ethnicity |
| Fetal Death | 287 | Father of Hispanic Origin?–Cuban | FETHNIC3 | extension:us-core-ethnicity |
| Fetal Death | 288 | Father of Hispanic Origin?–Other | FETHNIC4 | extension:us-core-ethnicity |
| Fetal Death | 289 | Father of Hispanic Origin?–Other Literal | FETHNIC5 | extension:us-core-ethnicity |
| Fetal Death | 290 | Father’s Race–White | FRACE1 | extension:us-core-race |
| Fetal Death | 299 | Father’s Race–Other Asian | FRACE10 | extension:us-core-race |
| Fetal Death | 300 | Father’s Race–Native Hawaiian | FRACE11 | extension:us-core-race |
| Fetal Death | 301 | Father’s Race–Guamanian or Chamorro | FRACE12 | extension:us-core-race |
| Fetal Death | 302 | Father’s Race–Samoan | FRACE13 | extension:us-core-race |
| Fetal Death | 303 | Father’s Race–Other Pacific Islander | FRACE14 | extension:us-core-race |
| Fetal Death | 304 | Father’s Race–Other | FRACE15 | extension:us-core-race |
| Fetal Death | 305 | Father’s Race–First American Indian or Alaska Native Literal | FRACE16 | extension:us-core-race |
| Fetal Death | 306 | Father’s Race–Second American Indian or Alaska Native Literal | FRACE17 | extension:us-core-race |
| Fetal Death | 307 | Father’s Race–First Other Asian Literal | FRACE18 | extension:us-core-race |
| Fetal Death | 308 | Father’s Race–Second Other Asian Literal | FRACE19 | extension:us-core-race |
| Fetal Death | 291 | Father’s Race–Black or African American | FRACE2 | extension:us-core-race |
| Fetal Death | 309 | Father’s Race–First Other Pacific Islander Literal | FRACE20 | extension:us-core-race |
| Fetal Death | 310 | Father’s Race–Second Other Pacific Islander Literal | FRACE21 | extension:us-core-race |
| Fetal Death | 311 | Father’s Race–First Other Literal | FRACE22 | extension:us-core-race |
| Fetal Death | 312 | Father’s Race–Second Other Literal | FRACE23 | extension:us-core-race |
| Fetal Death | 292 | Father’s Race–American Indian or Alaska Native | FRACE3 | extension:us-core-race |
| Fetal Death | 293 | Father’s Race–Asian Indian | FRACE4 | extension:us-core-race |
| Fetal Death | 294 | Father’s Race–Chinese | FRACE5 | extension:us-core-race |
| Fetal Death | 295 | Father’s Race–Filipino | FRACE6 | extension:us-core-race |
| Fetal Death | 296 | Father’s Race–Japanese | FRACE7 | extension:us-core-race |
| Fetal Death | 297 | Father’s Race–Korean | FRACE8 | extension:us-core-race |
| Fetal Death | 298 | Father’s Race–Vietnamese | FRACE9 | extension:us-core-race |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPersonFatherVitalRecords
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPersonFatherVitalRecords | The biological father of the newborn or fetus. | |
  relationship | 1..1 | CodeableConcept | natural father 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/v3-RoleCode | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPersonFatherVitalRecords | The biological father of the newborn or fetus. |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
 deceased | S | 0..1 | boolean, dateTime | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr |
| birthPlace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr |
| race | S | 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 |
| ethnicity | S | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier | SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by pattern:type |
  identifier:SSN | SΣ | 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 | SΣ | 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 - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | The patient this person is related to |
| relationship | SΣC | 1..1 | CodeableConcept | natural father Binding: ValueSet - Father Relationship - Vital Records (required): FatherRelationship 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/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| name | SΣC | 1..* | HumanName | A name associated with the person |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
| birthDate | SΣ | 0..1 | date | The date on which the related person was born |
| partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr |
| address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| RelatedPerson.identifier:SSN.use | required | IdentifierUse |
| RelatedPerson.identifier:SSN.type | extensible | Pattern: SS |
| RelatedPerson.relationship | required | Pattern: NFTH |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | If 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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPersonFatherVitalRecords | The biological father of the newborn or fetus. | ||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deceased | S | 0..1 | boolean, dateTime | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | ||||
| birthPlace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | ||||
| race | S | 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 | ||||
| ethnicity | S | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by pattern:type | ||||
| identifier:SSN | SΣ | 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 | SΣ | 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 - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | The patient this person is related to | ||||
| relationship | SΣC | 1..1 | CodeableConcept | natural father Binding: ValueSet - Father Relationship - Vital Records (required): FatherRelationship 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/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |||||
| 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 | |||||
| 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 | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 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 | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr | ||||
| 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.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.identifier:SSN.use | required | IdentifierUse | ||||
| RelatedPerson.identifier:SSN.type | extensible | Pattern: SS | ||||
| RelatedPerson.relationship | required | Pattern: NFTH | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | If 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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
This structure is derived from RelatedPersonFatherVitalRecords
Differential View
This structure is derived from RelatedPersonFatherVitalRecords
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPersonFatherVitalRecords | The biological father of the newborn or fetus. | |
| relationship | 1..1 | CodeableConcept | natural father 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/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPersonFatherVitalRecords | The biological father of the newborn or fetus. |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deceased | S | 0..1 | boolean, dateTime | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr |
| birthPlace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr |
| race | S | 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 |
| ethnicity | S | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by pattern:type |
| identifier:SSN | SΣ | 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 | SΣ | 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 - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | The patient this person is related to |
| relationship | SΣC | 1..1 | CodeableConcept | natural father Binding: ValueSet - Father Relationship - Vital Records (required): FatherRelationship 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/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| name | SΣC | 1..* | HumanName | A name associated with the person |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
| birthDate | SΣ | 0..1 | date | The date on which the related person was born |
| partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr |
| address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| RelatedPerson.identifier:SSN.use | required | IdentifierUse |
| RelatedPerson.identifier:SSN.type | extensible | Pattern: SS |
| RelatedPerson.relationship | required | Pattern: NFTH |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | If 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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPersonFatherVitalRecords | The biological father of the newborn or fetus. | ||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deceased | S | 0..1 | boolean, dateTime | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | ||||
| birthPlace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | ||||
| race | S | 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 | ||||
| ethnicity | S | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by pattern:type | ||||
| identifier:SSN | SΣ | 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 | SΣ | 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 - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | The patient this person is related to | ||||
| relationship | SΣC | 1..1 | CodeableConcept | natural father Binding: ValueSet - Father Relationship - Vital Records (required): FatherRelationship 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/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |||||
| 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 | |||||
| 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 | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 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 | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr | ||||
| 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.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.identifier:SSN.use | required | IdentifierUse | ||||
| RelatedPerson.identifier:SSN.type | extensible | Pattern: SS | ||||
| RelatedPerson.relationship | required | Pattern: NFTH | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | If 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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
This structure is derived from RelatedPersonFatherVitalRecords
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Public Health. Package hl7.fhir.us.vr-common-library#1.1.0 based on FHIR 4.0.1. Generated 2023-10-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change