Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: RelatedPerson
| Official URL: https://ancode.app/fhir/StructureDefinition/RelatedPerson | Version: 0.2.0 | |||
| Draft as of 2023-08-28 | Computable Name: RelatedPerson | |||
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
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 | 0..* | RelatedPerson | Pessoa Relacionada | |
  identifier | 1..* | Identifier | An identifier intended for computation | |
 active | 1..1 | boolean | Whether this related person's record is in active use | |
| relationship | 1..* | CodeableConcept | The nature of the relationship | |
| name | 1..* | HumanName | Name of a human - parts and usage | |
| telecom | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| gender | 1..1 | code | male | female | other | unknown | |
| address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
 photo | 0..1 | Attachment | Image of the person | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | Pessoa Relacionada | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..* | Identifier | An identifier intended for computation | |
| active | ?!Σ | 1..1 | boolean | Whether this related person's record is in active use |
 patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| name | 1..* | HumanName | Name of a human - parts and usage | |
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| photo | 0..1 | Attachment | Image of the person | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.gender | required | AdministrativeGender |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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.exists() and ('#'+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(uri) = '#').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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | Pessoa Relacionada | |||||
| 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): IETF language tag
| |||||
| 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 | 1..* | Identifier | An identifier intended for computation | |||||
| active | ?!Σ | 1..1 | boolean | Whether this related person's record is in active use | ||||
| patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
| relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| name | 1..* | HumanName | Name of a human - parts and usage | |||||
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 1..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 | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| photo | 0..1 | 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): IETF language tag
| |||||
| 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 |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | RelatedPerson.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| 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 | 0..* | RelatedPerson | Pessoa Relacionada | |
| identifier | 1..* | Identifier | An identifier intended for computation | |
| active | 1..1 | boolean | Whether this related person's record is in active use | |
| relationship | 1..* | CodeableConcept | The nature of the relationship | |
| name | 1..* | HumanName | Name of a human - parts and usage | |
| telecom | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| gender | 1..1 | code | male | female | other | unknown | |
| address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| photo | 0..1 | Attachment | Image of the person | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | Pessoa Relacionada | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..* | Identifier | An identifier intended for computation | |
| active | ?!Σ | 1..1 | boolean | Whether this related person's record is in active use |
| patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| name | 1..* | HumanName | Name of a human - parts and usage | |
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| photo | 0..1 | Attachment | Image of the person | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.gender | required | AdministrativeGender |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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.exists() and ('#'+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(uri) = '#').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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | Pessoa Relacionada | |||||
| 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): IETF language tag
| |||||
| 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 | 1..* | Identifier | An identifier intended for computation | |||||
| active | ?!Σ | 1..1 | boolean | Whether this related person's record is in active use | ||||
| patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
| relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| name | 1..* | HumanName | Name of a human - parts and usage | |||||
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 1..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 | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| photo | 0..1 | 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): IETF language tag
| |||||
| 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 |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | RelatedPerson.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| 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