Guia de Implementação do AnHealth
0.2.0 - CI Build
Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
| Draft as of 2023-08-28 |
Definitions for the RelatedPerson resource profile.
| 1. RelatedPerson | |
| Definition | Uma pessoa que está relacionada a um paciente, mas que não é um alvo direto do cuidado. Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
| 2. RelatedPerson.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* |
| Type | Identifier(Identifier) |
| 3. RelatedPerson.active | |
| Control | 10..1 |
| 4. RelatedPerson.relationship | |
| Control | 10..* |
| 5. RelatedPerson.name | |
| Control | 10..* |
| Type | HumanName(HumanName) |
| 6. RelatedPerson.telecom | |
| Type | ContactPoint(ContactPoint) |
| 7. RelatedPerson.gender | |
| Control | 10..1 |
| 8. RelatedPerson.address | |
| Type | Address(Address) |
| 9. RelatedPerson.photo | |
| Control | 0..1* |
| 1. RelatedPerson | |
| Definition | Uma pessoa que está relacionada a um paciente, mas que não é um alvo direto do cuidado. Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
| Control | 0..* |
| Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
| 2. RelatedPerson.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 3. RelatedPerson.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 4. RelatedPerson.identifier | |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Identifier for a person within a particular scope. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | Identifier(Identifier) |
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 5. RelatedPerson.active | |
| Definition | Whether this related person record is in active use. |
| Control | 10..1 |
| Type | boolean |
| Is Modifier | true |
| Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. |
| Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. RelatedPerson.patient | |
| Definition | The patient this person is related to. |
| Control | 1..1 |
| Type | Reference(Patient)) |
| Requirements | We need to know which patient this RelatedPerson is related to. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. RelatedPerson.relationship | |
| Definition | The nature of the relationship between a patient and the related person. |
| Control | 10..* |
| Binding | The codes SHOULD be taken from PatientRelationshipType The nature of the relationship between a patient and the related person. |
| Type | CodeableConcept |
| Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. RelatedPerson.name | |
| Definition | A human's name with the ability to identify parts and usage. A name associated with the person. |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | HumanName(HumanName) |
| Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 9. RelatedPerson.telecom | |
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail for the person, e.g. a telephone number or an email address. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | ContactPoint(ContactPoint) |
| Requirements | People have (primary) ways to contact them in some way such as phone, email. |
| Alternate Names | Contato, Informação de Contato, Telefone, E-Mail, Correio Eletrônico, Celular, Recado |
| Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
| Invariants | Defined on this element cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 10. RelatedPerson.gender | |
| Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes. |
| Type | code |
| Requirements | Needed for identification of the person, in combination with (at least) name and birth date. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. RelatedPerson.address | |
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Address where the related person can be contacted or visited. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Address(Address) |
| Requirements | Need to keep track where the related person can be contacted per postal mail or visited. |
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 12. RelatedPerson.photo | |
| Definition | Image of the person. |
| Control | 0..1* |
| Type | Attachment |
| Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 1. RelatedPerson | |||||
| Definition | Uma pessoa que está relacionada a um paciente, mas que não é um alvo direto do cuidado. | ||||
| Control | 0..* | ||||
| 2. RelatedPerson.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| 3. RelatedPerson.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 4. RelatedPerson.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 5. RelatedPerson.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages
IETF language ta
| ||||
| Type | code | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 6. RelatedPerson.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrativehtmlxhtmldisplay | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 7. RelatedPerson.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resourcesanonymous resourcescontained resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Invariants | Defined on this element dom-r4b: 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)) | ||||
| 8. RelatedPerson.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 9. RelatedPerson.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 10. RelatedPerson.identifier | |||||
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier(Identifier) | ||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 11. RelatedPerson.active | |||||
| Definition | Whether this related person record is in active use. | ||||
| Control | 1..1 | ||||
| Type | boolean | ||||
| Is Modifier | true | ||||
| Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. | ||||
| Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 12. RelatedPerson.patient | |||||
| Definition | The patient this person is related to. | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient)) | ||||
| Requirements | We need to know which patient this RelatedPerson is related to. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 13. RelatedPerson.relationship | |||||
| Definition | The nature of the relationship between a patient and the related person. | ||||
| Control | 1..* | ||||
| Binding | The codes SHOULD be taken from PatientRelationshipType The nature of the relationship between a patient and the related person | ||||
| Type | CodeableConcept | ||||
| Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 14. RelatedPerson.name | |||||
| Definition | A human's name with the ability to identify parts and usage. | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | HumanName(HumanName) | ||||
| Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. | ||||
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 15. RelatedPerson.telecom | |||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(ContactPoint) | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | ContatoInformação de ContatoTelefoneE-MailCorreio EletrônicoCelularRecado | ||||
| Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||||
| Invariants | Defined on this element cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 16. RelatedPerson.gender | |||||
| Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes | ||||
| Type | code | ||||
| Requirements | Needed for identification of the person, in combination with (at least) name and birth date. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 17. RelatedPerson.birthDate | |||||
| Definition | The date on which the related person was born. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 18. RelatedPerson.address | |||||
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Address(Address) | ||||
| Requirements | Need to keep track where the related person can be contacted per postal mail or visited. | ||||
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 19. RelatedPerson.photo | |||||
| Definition | Image of the person. | ||||
| Control | 0..1 | ||||
| Type | Attachment | ||||
| Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 20. RelatedPerson.period | |||||
| Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 21. RelatedPerson.communication | |||||
| Definition | A language which may be used to communicate with about the patient's health. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. | ||||
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 22. RelatedPerson.communication.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 23. RelatedPerson.communication.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser content | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 24. RelatedPerson.communication.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensionsuser contentmodifiers | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 25. RelatedPerson.communication.language | |||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages
IETF language ta
| ||||
| Type | CodeableConcept | ||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 26. RelatedPerson.communication.preferred | |||||
| Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. | ||||
| Comments | This language is specifically identified for communicating healthcare information. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||