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

CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®), published by HL7 Financial Management Working Group. This is not an authorized publication; it is the continuous build for version 2.0.0). 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.0.0
Active as of 2022-11-28 Computable Name: C4BBRelatedPerson

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

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both)
relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... active S1..1booleanWhether this related person's record is in active use
... patient S1..1Reference(C4BB Patient)The patient this person is related to
... name S0..*HumanNameA name associated with the person
... telecom S0..*ContactPointA contact detail for the person
... address S0..*AddressAddress where the related person can be contacted or visited

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
relatedperson-meta-profile-versionerrorRelatedPersonRelatedPerson: meta.profile with canonical and major.minor. version required.
: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationshiperrorRelatedPersonEither a name or a relationship SHALL be provided (or both)
: name.exists() or relationship.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both)
relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
... meta SΣ1..1MetaMetadata about the resource
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... patient SΣ1..1Reference(C4BB Patient)The patient this person is related to
... relationship SΣ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣ0..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... address SΣ0..*AddressAddress where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.relationshippreferredPatientRelationshipType

Constraints

IdGradePath(s)DetailsRequirements
relatedperson-meta-profile-versionerrorRelatedPersonRelatedPerson: meta.profile with canonical and major.minor. version required.
: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationshiperrorRelatedPersonEither a name or a relationship SHALL be provided (or both)
: name.exists() or relationship.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both)
relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
... id Σ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(C4BB Patient)The patient this person is related to
... relationship SΣ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣ0..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address SΣ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.meta.securityextensibleAll Security Labels
RelatedPerson.meta.tagexampleCommonTags
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

This structure is derived from RelatedPerson

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both)
relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... active S1..1booleanWhether this related person's record is in active use
... patient S1..1Reference(C4BB Patient)The patient this person is related to
... name S0..*HumanNameA name associated with the person
... telecom S0..*ContactPointA contact detail for the person
... address S0..*AddressAddress where the related person can be contacted or visited

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
relatedperson-meta-profile-versionerrorRelatedPersonRelatedPerson: meta.profile with canonical and major.minor. version required.
: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationshiperrorRelatedPersonEither a name or a relationship SHALL be provided (or both)
: name.exists() or relationship.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both)
relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
... meta SΣ1..1MetaMetadata about the resource
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... patient SΣ1..1Reference(C4BB Patient)The patient this person is related to
... relationship SΣ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣ0..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... address SΣ0..*AddressAddress where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.relationshippreferredPatientRelationshipType

Constraints

IdGradePath(s)DetailsRequirements
relatedperson-meta-profile-versionerrorRelatedPersonRelatedPerson: meta.profile with canonical and major.minor. version required.
: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationshiperrorRelatedPersonEither a name or a relationship SHALL be provided (or both)
: name.exists() or relationship.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both)
relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
... id Σ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(C4BB Patient)The patient this person is related to
... relationship SΣ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣ0..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address SΣ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.meta.securityextensibleAll Security Labels
RelatedPerson.meta.tagexampleCommonTags
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

This structure is derived from RelatedPerson

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron