CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
2.2.1 - STU 2.2 United States of America flag

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.2.1 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

Resource Profile: C4BB RelatedPerson

Official URL: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson Version: 2.2.1
Standards status: Trial-use Maturity Level: 2 Computable Name: C4BBRelatedPerson
Other Identifiers: OID:2.16.840.1.113883.4.642.40.3.42.16

This profile is used to convey basic demographic information about a person related to the claim.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(7.0.0) A person that is related to a patient, but who is not a direct target of care
This profile also complies with the profile US Core RelatedPerson Profile (6.1.0)
Constraints: us-core-14
... 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
... patient SΣ 1..1 Reference(C4BB Patient) The patient this person is related to
... relationship SΣC 0..* CodeableConcept 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 A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... address SΣ 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile(7.0.0) A person that is related to a patient, but who is not a direct target of care
This profile also complies with the profile US Core RelatedPerson Profile (6.1.0)
... 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) The patient this person is related to

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(7.0.0) A person that is related to a patient, but who is not a direct target of care
This profile also complies with the profile US Core RelatedPerson Profile (6.1.0)
Constraints: us-core-14
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Whether this related person's record is in active use
... patient SΣ 1..1 Reference(C4BB Patient) The patient this person is related to
... relationship SΣC 0..* CodeableConcept 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 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 Σ 0..1 date The date on which the related person was born
... address SΣ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
RelatedPerson.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
RelatedPerson.language Base preferred Common Languages 📦4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(7.0.0) A person that is related to a patient, but who is not a direct target of care
This profile also complies with the profile US Core RelatedPerson Profile (6.1.0)
Constraints: us-core-14
... 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
... patient SΣ 1..1 Reference(C4BB Patient) The patient this person is related to
... relationship SΣC 0..* CodeableConcept 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 A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... address SΣ 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile(7.0.0) A person that is related to a patient, but who is not a direct target of care
This profile also complies with the profile US Core RelatedPerson Profile (6.1.0)
... 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) The patient this person is related to

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(7.0.0) A person that is related to a patient, but who is not a direct target of care
This profile also complies with the profile US Core RelatedPerson Profile (6.1.0)
Constraints: us-core-14
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Whether this related person's record is in active use
... patient SΣ 1..1 Reference(C4BB Patient) The patient this person is related to
... relationship SΣC 0..* CodeableConcept 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 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 Σ 0..1 date The date on which the related person was born
... address SΣ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
RelatedPerson.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
RelatedPerson.language Base preferred Common Languages 📦4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron