CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®), published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0-snapshot1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-bb/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson | Version: 2.1.0-snapshot1 | |||
Standards status: Trial-use | Computable Name: C4BBRelatedPerson |
This profile is used to convey basic demographic information about a person related to the claim.
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 | |||
meta | S | 1..1 | Meta | Metadata about the resource |
lastUpdated | S | 1..1 | instant | When the resource version last changed |
profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
patient | 1..1 | Reference(C4BB Patient) | (USCDI) The patient this person is related to | |
Documentation for this format |
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 us-core-14: Either a name or a relationship SHALL be provided (or both) |
meta | SΣ | 1..1 | Meta | Metadata about the resource |
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!SΣ | 1..1 | boolean | (USCDI) Whether this related person's record is in active use |
patient | SΣ | 1..1 | Reference(C4BB Patient) | (USCDI) The patient this person is related to |
relationship | SΣC | 0..* | CodeableConcept | (USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
name | SΣC | 0..* | HumanName | (USCDI) A name associated with the person |
telecom | SΣ | 0..* | ContactPoint | (USCDI) A contact detail for the person |
address | SΣ | 0..* | Address | (USCDI) Address where the related person can be contacted or visited |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard |
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 us-core-14: Either a name or a relationship SHALL be provided (or both) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
active | ?!SΣ | 1..1 | boolean | (USCDI) Whether this related person's record is in active use | ||||
patient | SΣ | 1..1 | Reference(C4BB Patient) | (USCDI) The patient this person is related to | ||||
relationship | SΣC | 0..* | CodeableConcept | (USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
name | SΣC | 0..* | HumanName | (USCDI) A name associated with the person | ||||
telecom | SΣ | 0..* | ContactPoint | (USCDI) 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 | Σ | 0..1 | date | The date on which the related person was born | ||||
address | SΣ | 0..* | Address | (USCDI) 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 | URI | |||
RelatedPerson.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
This structure is derived from USCoreRelatedPersonProfile
Differential View
This structure is derived from USCoreRelatedPersonProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | USCoreRelatedPersonProfile | |||
meta | S | 1..1 | Meta | Metadata about the resource |
lastUpdated | S | 1..1 | instant | When the resource version last changed |
profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
patient | 1..1 | Reference(C4BB Patient) | (USCDI) The patient this person is related to | |
Documentation for this format |
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 us-core-14: Either a name or a relationship SHALL be provided (or both) |
meta | SΣ | 1..1 | Meta | Metadata about the resource |
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!SΣ | 1..1 | boolean | (USCDI) Whether this related person's record is in active use |
patient | SΣ | 1..1 | Reference(C4BB Patient) | (USCDI) The patient this person is related to |
relationship | SΣC | 0..* | CodeableConcept | (USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
name | SΣC | 0..* | HumanName | (USCDI) A name associated with the person |
telecom | SΣ | 0..* | ContactPoint | (USCDI) A contact detail for the person |
address | SΣ | 0..* | Address | (USCDI) Address where the related person can be contacted or visited |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard |
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 us-core-14: Either a name or a relationship SHALL be provided (or both) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
active | ?!SΣ | 1..1 | boolean | (USCDI) Whether this related person's record is in active use | ||||
patient | SΣ | 1..1 | Reference(C4BB Patient) | (USCDI) The patient this person is related to | ||||
relationship | SΣC | 0..* | CodeableConcept | (USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
name | SΣC | 0..* | HumanName | (USCDI) A name associated with the person | ||||
telecom | SΣ | 0..* | ContactPoint | (USCDI) 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 | Σ | 0..1 | date | The date on which the related person was born | ||||
address | SΣ | 0..* | Address | (USCDI) 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 | URI | |||
RelatedPerson.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
This structure is derived from USCoreRelatedPersonProfile
Other representations of profile: CSV, Excel, Schematron