This page is part of the CARIN Blue Button Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, 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 Dec 23 19:40:59 UTC 2019 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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..1 | CodeableConcept | Binding: CARIN Blue Button Identifier Type Value Set (extensible) | |
 identifier:memberid | 0..* | Identifier | ||
 type | 0..1 | CodeableConcept | Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
| identifier:subscriberid | 1..* | Identifier | ||
| type | 0..1 | CodeableConcept | Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SN | |
 patient | 1..1 | Reference(CARIN Blue Button Patient Profile) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | I | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | (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..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 1..1 | CodeableConcept | Description of identifier Binding: CARIN Blue Button Identifier Type Value Set (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:memberid | ΣI | 0..* | Identifier | A human identifier for this person |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) 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 | 0..1 | uri | Identity of the terminology system | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
| 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 | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:subscriberid | ΣI | 1..* | Identifier | A human identifier for this person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) 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 | 0..1 | uri | Identity of the terminology system | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SN | |
| 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 | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!ΣI | 0..1 | boolean | Whether this related person's record is in active use |
| patient | ΣI | 1..1 | Reference(CARIN Blue Button Patient Profile) | The patient this person is related to |
| relationship | ΣI | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred) |
| name | ΣI | 0..* | HumanName | A name associated with the person |
| telecom | ΣI | 0..* | ContactPoint | A contact detail for the person |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | ΣI | 0..1 | date | The date on which the related person was born |
| address | ΣI | 0..* | Address | Address where the related person can be contacted or visited |
| photo | I | 0..* | Attachment | Image of the person |
| period | I | 0..1 | Period | Period of time that this relationship is considered valid |
| communication | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| preferred | I | 0..1 | boolean | Language preference indicator |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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..1 | CodeableConcept | Binding: CARIN Blue Button Identifier Type Value Set (extensible) | |
| identifier:memberid | 0..* | Identifier | ||
| type | 0..1 | CodeableConcept | Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
| identifier:subscriberid | 1..* | Identifier | ||
| type | 0..1 | CodeableConcept | Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SN | |
| patient | 1..1 | Reference(CARIN Blue Button Patient Profile) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | I | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | (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..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 1..1 | CodeableConcept | Description of identifier Binding: CARIN Blue Button Identifier Type Value Set (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:memberid | ΣI | 0..* | Identifier | A human identifier for this person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) 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 | 0..1 | uri | Identity of the terminology system | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |
| 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 | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:subscriberid | ΣI | 1..* | Identifier | A human identifier for this person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) 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 | 0..1 | uri | Identity of the terminology system | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SN | |
| 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 | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!ΣI | 0..1 | boolean | Whether this related person's record is in active use |
| patient | ΣI | 1..1 | Reference(CARIN Blue Button Patient Profile) | The patient this person is related to |
| relationship | ΣI | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred) |
| name | ΣI | 0..* | HumanName | A name associated with the person |
| telecom | ΣI | 0..* | ContactPoint | A contact detail for the person |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | ΣI | 0..1 | date | The date on which the related person was born |
| address | ΣI | 0..* | Address | Address where the related person can be contacted or visited |
| photo | I | 0..* | Attachment | Image of the person |
| period | I | 0..1 | Period | Period of time that this relationship is considered valid |
| communication | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| preferred | I | 0..1 | boolean | Language preference indicator |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
