SHINNYIG - Local Development build (v0.2). See the Directory of published versions
Resource Profile: US Core RelatedPerson Profile
| Official URL: http://shinny.org/StructureDefinition/us-core-relatedperson | Version: 0.2 | |||
| Active as of 2022-04-20 |
Realm: 
|
Computable Name: USCoreRelatedPersonProfile | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
This profile sets minimum expectations for the RelatedPerson resource to record, search, and fetch related persons associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. It provides the floor for standards development for specific uses cases.
Usage:
- Refer to this Resource Profile: SHINNY Observation Profile, US Core CareTeam Profile, US Core DocumentReference Profile, US Core Encounter Profile... Show 3 more
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | C | 0..* | RelatedPerson | 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) |
  active | S | 1..1 | boolean | Whether this related person's record is in active use |
 patient | S | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to |
| relationship | SC | 0..* | CodeableConcept | The nature of the relationship |
| name | SC | 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 |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPerson | 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) |
 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 | Whether this related person's record is in active use |
| patient | SΣ | 1..1 | Reference(US Core Patient Profile) | 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 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPerson | 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 | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | Whether this related person's record is in active use | ||||
| patient | SΣ | 1..1 | Reference(US Core Patient Profile) | 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.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.relationship | preferred | PatientRelationshipType | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from RelatedPerson
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPerson | 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) |
| active | S | 1..1 | boolean | Whether this related person's record is in active use |
| patient | S | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to |
| relationship | SC | 0..* | CodeableConcept | The nature of the relationship |
| name | SC | 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 |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPerson | 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) |
| 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 | Whether this related person's record is in active use |
| patient | SΣ | 1..1 | Reference(US Core Patient Profile) | 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 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-14 | error | RelatedPerson | Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | C | 0..* | RelatedPerson | 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 | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | Whether this related person's record is in active use | ||||
| patient | SΣ | 1..1 | Reference(US Core Patient Profile) | 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.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.relationship | preferred | PatientRelationshipType | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from RelatedPerson
Other representations of profile: CSV, Excel, Schematron