Vital Records Common Library (VRCL) STU2-ballot
2.0.0-ballot - ballot
Vital Records Common Library (VRCL) STU2-ballot
2.0.0-ballot - ballot
This page is part of the Vital Records Common Profile Library (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. 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-parent-vr | Version: 2.0.0-ballot | |||
| Draft as of 2023-12-16 | Computable Name: RelatedPersonParentVitalRecords | |||
The RelatedPerson profile contains constraints common to the Mother and Father profiles. Serves as resource profile for RelatedPersonMother and RelatedPersonFather. This profile is designed to supplant the similar profile in VRDR
This profile is based on the US Core RelatedPerson profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreRelatedPersonProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | USCoreRelatedPersonProfile | |||
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 deceased | 0..1 | boolean, dateTime | Extension - RelatedPerson Deceased Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | |
| birthPlace | 0..1 | Address | Extension - RelatedPerson Birth Place Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | |
| race | 0..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 | 0..1 | (Complex) | If ethnicity is unknown omit both coded data fields. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
  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 | |
   type | 1..1 | CodeableConcept | Description of identifier 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 | |
 patient | 1..1 | Reference(Patient - Vital Records) | The patient this person is related to | |
| relationship | 1..* | CodeableConcept | The nature of the relationship | |
| name | 1..* | HumanName | A name associated with the person | |
| birthDate | S | 0..1 | date | The date on which the related person was born |
| 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/ExtensionPartialDateVitalRecords |
| bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records URL: 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| RelatedPerson.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | USCoreRelatedPersonProfile | A person that is related to a patient, but who is not a direct target of care |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deceased | 0..1 | boolean, dateTime | Extension - RelatedPerson Deceased Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | |
| birthPlace | 0..1 | Address | Extension - RelatedPerson Birth Place Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | |
| race | 0..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 | 0..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 | Σ | 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 |
 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 | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| 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 |
| 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/ExtensionPartialDateVitalRecords |
| bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
| 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
| 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 | preferred | PatientRelationshipType |
| RelatedPerson.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | C | 0..* | USCoreRelatedPersonProfile | A person that is related to a patient, but who is not a direct target of care | ||||
| 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deceased | 0..1 | boolean, dateTime | Extension - RelatedPerson Deceased Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | |||||
| birthPlace | 0..1 | Address | Extension - RelatedPerson Birth Place Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | |||||
| race | 0..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 | 0..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 | Σ | 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 | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| 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/ExtensionPartialDateVitalRecords | ||||
| bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records 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: ValueSet - Mothers 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.
| |||||
| 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 | preferred | PatientRelationshipType | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
This structure is derived from USCoreRelatedPersonProfile
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreRelatedPersonProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | USCoreRelatedPersonProfile | |||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deceased | 0..1 | boolean, dateTime | Extension - RelatedPerson Deceased Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | |
| birthPlace | 0..1 | Address | Extension - RelatedPerson Birth Place Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | |
| race | 0..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 | 0..1 | (Complex) | If ethnicity is unknown omit both coded data fields. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| 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 | |
| type | 1..1 | CodeableConcept | Description of identifier 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 | |
| patient | 1..1 | Reference(Patient - Vital Records) | The patient this person is related to | |
| relationship | 1..* | CodeableConcept | The nature of the relationship | |
| name | 1..* | HumanName | A name associated with the person | |
| birthDate | S | 0..1 | date | The date on which the related person was born |
| 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/ExtensionPartialDateVitalRecords |
| bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records URL: 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| RelatedPerson.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | USCoreRelatedPersonProfile | A person that is related to a patient, but who is not a direct target of care |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deceased | 0..1 | boolean, dateTime | Extension - RelatedPerson Deceased Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | |
| birthPlace | 0..1 | Address | Extension - RelatedPerson Birth Place Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | |
| race | 0..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 | 0..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 | Σ | 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 |
| 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 | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| 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 |
| 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/ExtensionPartialDateVitalRecords |
| bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
| 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
| 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 | preferred | PatientRelationshipType |
| RelatedPerson.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | C | 0..* | USCoreRelatedPersonProfile | A person that is related to a patient, but who is not a direct target of care | ||||
| 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deceased | 0..1 | boolean, dateTime | Extension - RelatedPerson Deceased Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased-vr | |||||
| birthPlace | 0..1 | Address | Extension - RelatedPerson Birth Place Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace-vr | |||||
| race | 0..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 | 0..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 | Σ | 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 | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| 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/ExtensionPartialDateVitalRecords | ||||
| bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records 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: ValueSet - Mothers 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.
| |||||
| 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 | preferred | PatientRelationshipType | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
This structure is derived from USCoreRelatedPersonProfile
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Public Health. Package hl7.fhir.us.vr-common-library#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change