Consumer-Directed Payer Data Exchange
- Release 0.1.0

Consumer-Directed Payer Data Exchange, published by CARIN Alliance. This is not an authorized publication; it is the continuous build for version 0.1.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

SD.10 StructureDefinition-CARIN-BB-RelatedPerson

This profile builds on the RelatedPerson Resource. It includes additional constraints relevant for the use cases addressed by this IG.

SD.10.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-relatedperson

Published on Mon Mar 16 09:12:36 UTC 2020 as a active by CARIN Alliance.

This profile builds on RelatedPerson


Summary

Mandatory: 1 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element RelatedPerson.identifier is sliced based on the values of value:type, value:system
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPerson
... identifier 0..*(Slice Definition)Slice: Unordered, Open by value:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... type 1..1CodeableConceptBinding: CARIN Blue Button Identifier Type Value Set (extensible)
.... identifier:memberid 0..*Identifier
..... type 0..1CodeableConceptRequired Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
.... identifier:subscriberid 1..*Identifier
..... type 0..1CodeableConceptRequired Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SN
... patient 1..1Reference(CARIN Blue Button Patient Profile)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)A human identifier for this person
Slice: Unordered, Open by value:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: CARIN Blue Button Identifier Type Value Set (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:memberid ΣI0..*IdentifierA human identifier for this person
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system0..1uriIdentity of the terminology system
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:subscriberid ΣI1..*IdentifierA human identifier for this person
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system0..1uriIdentity of the terminology system
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this related person's record is in active use
... patient ΣI1..1Reference(CARIN Blue Button Patient Profile)The patient this person is related to
... relationship ΣI0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred)
... name ΣI0..*HumanNameA name associated with the person
... telecom ΣI0..*ContactPointA contact detail for the person
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the related person was born
... address ΣI0..*AddressAddress where the related person can be contacted or visited
... photo I0..*AttachmentImage of the person
... period I0..1PeriodPeriod of time that this relationship is considered valid
... communication I0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..1booleanLanguage preference indicator

doco Documentation for this format
{% include StructureDefinition-CARIN-BB-RelatedPerson-pseudo-xml.xhtml %}
{% include StructureDefinition-CARIN-BB-RelatedPerson-pseudo-json.xhtml %}

Summary

Mandatory: 1 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element RelatedPerson.identifier is sliced based on the values of value:type, value:system

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPerson
... identifier 0..*(Slice Definition)Slice: Unordered, Open by value:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... type 1..1CodeableConceptBinding: CARIN Blue Button Identifier Type Value Set (extensible)
.... identifier:memberid 0..*Identifier
..... type 0..1CodeableConceptRequired Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
.... identifier:subscriberid 1..*Identifier
..... type 0..1CodeableConceptRequired Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SN
... patient 1..1Reference(CARIN Blue Button Patient Profile)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)A human identifier for this person
Slice: Unordered, Open by value:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: CARIN Blue Button Identifier Type Value Set (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:memberid ΣI0..*IdentifierA human identifier for this person
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system0..1uriIdentity of the terminology system
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:subscriberid ΣI1..*IdentifierA human identifier for this person
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system0..1uriIdentity of the terminology system
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this related person's record is in active use
... patient ΣI1..1Reference(CARIN Blue Button Patient Profile)The patient this person is related to
... relationship ΣI0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred)
... name ΣI0..*HumanNameA name associated with the person
... telecom ΣI0..*ContactPointA contact detail for the person
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the related person was born
... address ΣI0..*AddressAddress where the related person can be contacted or visited
... photo I0..*AttachmentImage of the person
... period I0..1PeriodPeriod of time that this relationship is considered valid
... communication I0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..1booleanLanguage preference indicator

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron