Guia de Implementação da iPES - CI build
0.1.0 - ci-build

!!Guia de Implementação da iPES - CI build - Compilação de desenvolvimento local (v0.1.0) construída pelas ferramentas de compilação FHIR (HL7® FHIR® Standard). Veja o Diretório de versões publicadas

Resource Profile: AllergyIntoleranceBRIPES - Detailed Descriptions

Draft as of 2025-06-24

Definitions for the AllergyIntoleranceBRIPES resource profile.

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. AllergyIntolerance
Definição

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

CurtoAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
Comentários

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

Controlo0..*
É modificadorfalse
Resumofalse
Nomes alternativosAllergy, Intolerance, Adverse Reaction
Invariantesait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists())
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty())
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 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: 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())
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists())
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty())
2. AllergyIntolerance.implicitRules
Definição

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.

CurtoA set of rules under which this content was created
Comentários

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.

Controlo0..1
Tipouri
É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. AllergyIntolerance.modifierExtension
Definição

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).

CurtoExtensions that cannot be ignored
Comentários

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.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumofalse
Requisitos

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.

Nomes alternativosextensions, user content
Invariantesele-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())
6. AllergyIntolerance.identifier
Definição

Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

CurtoExternal ids for this item
Comentários

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0*
TipoIdentifier
É modificadorfalse
Resumotrue
Requisitos

Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. AllergyIntolerance.clinicalStatus
Definição

The clinical status of the allergy or intolerance.

Curtoactive | inactive | resolved
Comentários

Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Controlo0..1
Este elemento é afetado pelas seguintes invariantes: ait-1, ait-2
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
(required to http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1)

The clinical status of the allergy or intolerance.

TipoCodeableConcept
É modificadortrue porque This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. AllergyIntolerance.verificationStatus
Definição

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

Curtounconfirmed | confirmed | refuted | entered-in-error
Comentários

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Controlo0..1
Este elemento é afetado pelas seguintes invariantes: ait-1, ait-2
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
(required to http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1)

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

TipoCodeableConcept
É modificadortrue porque This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. AllergyIntolerance.code
Definição

Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

CurtoCode that identifies the allergy or intolerance
Comentários

It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de Para exemplos de códigos, ver https://terminologia.saude.gov.br/fhir/ValueSet/BRAlergenoshttp://hl7.org/fhir/ValueSet/allergyintolerance-code
(preferred to https://terminologia.saude.gov.br/fhir/ValueSet/BRAlergenos)
TipoCodeableConcept
É modificadorfalse
Resumotrue
Nomes alternativosCode
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. AllergyIntolerance.patient
Definição

The patient who has the allergy or intolerance.

CurtoWho the sensitivity is for
Controlo1..1
TipoReference(Paciente, Patient)
É modificadorfalse
Resumotrue
Nomes alternativosPatient
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. AllergyIntolerance.patient.reference
Definição

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

CurtoLiteral reference, Relative, internal or absolute URL
Comentários

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Controlo10..1
Este elemento é afetado pelas seguintes invariantes: ref-1
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. AllergyIntolerance.patient.type
Definição

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

CurtoType the reference refers to (e.g. "Patient")
Comentários

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Controlo0..01
VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
(extensible to http://hl7.org/fhir/ValueSet/resource-types)

Aa resource (or, for logical models, the URI of the logical model).

Tipouri
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. AllergyIntolerance.patient.identifier
Definição

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

CurtoLogical reference, when literal reference is not known
Comentários

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..01
TipoIdentifier
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. AllergyIntolerance.patient.display
Definição

Plain text narrative that identifies the resource in addition to the resource reference.

CurtoText alternative for the resource
Comentários

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Controlo0..01
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. AllergyIntolerance.encounter
Definição

The encounter when the allergy or intolerance was asserted.

CurtoEncounter when the allergy or intolerance was asserted
Controlo0..1
TipoReference(Contato Assistencial, Encounter)
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. AllergyIntolerance.encounter.reference
Definição

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

CurtoLiteral reference, Relative, internal or absolute URL
Comentários

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Controlo10..1
Este elemento é afetado pelas seguintes invariantes: ref-1
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. AllergyIntolerance.encounter.type
Definição

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

CurtoType the reference refers to (e.g. "Patient")
Comentários

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Controlo0..01
VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
(extensible to http://hl7.org/fhir/ValueSet/resource-types)

Aa resource (or, for logical models, the URI of the logical model).

Tipouri
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. AllergyIntolerance.encounter.identifier
Definição

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

CurtoLogical reference, when literal reference is not known
Comentários

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..01
TipoIdentifier
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. AllergyIntolerance.encounter.display
Definição

Plain text narrative that identifies the resource in addition to the resource reference.

CurtoText alternative for the resource
Comentários

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Controlo0..01
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. AllergyIntolerance.recorder
Definição

Individual who recorded the record and takes responsibility for its content.

CurtoWho recorded the sensitivity
Controlo0..01
TipoReference(Practitioner, PractitionerRole, Patient, RelatedPerson)
É modificadorfalse
Resumofalse
Nomes alternativosAuthor
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. AllergyIntolerance.asserter
Definição

The source of the information about the allergy that is recorded.

CurtoSource of the information about the allergy
Comentários

The recorder takes responsibility for the content, but can reference the source from where they got it.

Controlo0..01
TipoReference(Patient, RelatedPerson, Practitioner, PractitionerRole)
É modificadorfalse
Resumotrue
Nomes alternativosSource, Informant
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. AllergyIntolerance.lastOccurrence
Definição

Represents the date and/or time of the last known occurrence of a reaction event.

CurtoDate(/time) of last known occurrence of a reaction
Comentários

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

Controlo0..01
TipodateTime
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. AllergyIntolerance
2. AllergyIntolerance.identifier
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
4. AllergyIntolerance.code
VínculoOs códigos DEVERÃO ser retirados de https://terminologia.saude.gov.br/fhir/ValueSet/BRAlergenos
(preferred to https://terminologia.saude.gov.br/fhir/ValueSet/BRAlergenos)
6. AllergyIntolerance.patient
TipoReference(Paciente)
8. AllergyIntolerance.patient.reference
Controlo1..?
10. AllergyIntolerance.patient.type
Controlo0..0
12. AllergyIntolerance.patient.identifier
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
14. AllergyIntolerance.patient.display
Controlo0..0
16. AllergyIntolerance.encounter
TipoReference(Contato Assistencial)
18. AllergyIntolerance.encounter.reference
Controlo1..?
20. AllergyIntolerance.encounter.type
Controlo0..0
22. AllergyIntolerance.encounter.identifier
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
24. AllergyIntolerance.encounter.display
Controlo0..0
26. AllergyIntolerance.recorder
Controlo0..0
28. AllergyIntolerance.asserter
Controlo0..0
30. AllergyIntolerance.lastOccurrence
Controlo0..0
32. AllergyIntolerance.note
34. AllergyIntolerance.note.author[x]
Controlo0..0
36. AllergyIntolerance.note.time
Controlo0..0
38. AllergyIntolerance.reaction
40. AllergyIntolerance.reaction.substance
Controlo0..0
42. AllergyIntolerance.reaction.manifestation
VínculoOs códigos DEVERÃO ser retirados de https://terminologia.saude.gov.br/fhir/ValueSet/BRReacoesAdversasMedDRA
(preferred to https://terminologia.saude.gov.br/fhir/ValueSet/BRReacoesAdversasMedDRA)
44. AllergyIntolerance.reaction.onset
Controlo0..0
46. AllergyIntolerance.reaction.severity
Controlo0..0
48. AllergyIntolerance.reaction.exposureRoute
Controlo0..0
50. AllergyIntolerance.reaction.note
Controlo0..0

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. AllergyIntolerance
Definição

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

CurtoAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
Comentários

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

Controlo0..*
É modificadorfalse
Resumofalse
Nomes alternativosAllergy, Intolerance, Adverse Reaction
Invariantesait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists())
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty())
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 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: 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. AllergyIntolerance.id
Definição

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

CurtoLogical id of this artifact
Comentários

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Controlo0..1
Tipoid
É modificadorfalse
Resumotrue
4. AllergyIntolerance.meta
Definição

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.

CurtoMetadata about the resource
Controlo0..1
TipoMeta
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. AllergyIntolerance.implicitRules
Definição

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.

CurtoA set of rules under which this content was created
Comentários

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.

Controlo0..1
Tipouri
É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. AllergyIntolerance.language
Definição

The base language in which the resource is written.

CurtoLanguage of the resource content
Comentários

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).

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Vínculos adicionaisObjetivo
AllLanguagesVínculo máximo
Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. AllergyIntolerance.text
Definição

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.

CurtoText summary of the resource, for human interpretation
Comentários

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.

Controlo0..1
TipoNarrative
É modificadorfalse
Resumofalse
Nomes alternativosnarrative, html, xhtml, display
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. AllergyIntolerance.contained
Definição

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.

CurtoContained, inline Resources
Comentários

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.

Controlo0..*
TipoResource
É modificadorfalse
Resumofalse
Nomes alternativosinline resources, anonymous resources, contained resources
14. AllergyIntolerance.extension
Definição

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.

CurtoAdditional content defined by implementations
Comentários

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.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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())
16. AllergyIntolerance.modifierExtension
Definição

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).

CurtoExtensions that cannot be ignored
Comentários

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.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumofalse
Requisitos

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.

Nomes alternativosextensions, user content
Invariantesele-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())
18. AllergyIntolerance.identifier
Definição

Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

CurtoExternal ids for this item
Comentários

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
TipoIdentifier
É modificadorfalse
Resumotrue
Requisitos

Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. AllergyIntolerance.clinicalStatus
Definição

The clinical status of the allergy or intolerance.

Curtoactive | inactive | resolved
Comentários

Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Controlo0..1
Este elemento é afetado pelas seguintes invariantes: ait-1, ait-2
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceClinicalStatusCodes
(required to http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1)

The clinical status of the allergy or intolerance.

TipoCodeableConcept
É modificadortrue porque This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. AllergyIntolerance.verificationStatus
Definição

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

Curtounconfirmed | confirmed | refuted | entered-in-error
Comentários

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Controlo0..1
Este elemento é afetado pelas seguintes invariantes: ait-1, ait-2
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceVerificationStatusCodes
(required to http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1)

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

TipoCodeableConcept
É modificadortrue porque This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. AllergyIntolerance.type
Definição

Identification of the underlying physiological mechanism for the reaction risk.

Curtoallergy | intolerance - Underlying mechanism (if known)
Comentários

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceType
(required to http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1)

Identification of the underlying physiological mechanism for a Reaction Risk.

Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Nomes alternativosCategory, Class
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. AllergyIntolerance.category
Definição

Category of the identified substance.

Curtofood | medication | environment | biologic
Comentários

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

Controlo0..*
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceCategory
(required to http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1)

Category of an identified substance associated with allergies or intolerances.

Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Nomes alternativosCategory, Type, Reaction Type, Class
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. AllergyIntolerance.criticality
Definição

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

Curtolow | high | unable-to-assess
Comentários

The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceCriticality
(required to http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1)

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Nomes alternativosSeverity, Seriousness, Contra-indication, Risk
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. AllergyIntolerance.code
Definição

Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

CurtoCode that identifies the allergy or intolerance
Comentários

It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de https://terminologia.saude.gov.br/fhir/ValueSet/BRAlergenos
(preferred to https://terminologia.saude.gov.br/fhir/ValueSet/BRAlergenos)
TipoCodeableConcept
É modificadorfalse
Resumotrue
Nomes alternativosCode
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. AllergyIntolerance.patient
Definição

The patient who has the allergy or intolerance.

CurtoWho the sensitivity is for
Controlo1..1
TipoReference(Paciente)
É modificadorfalse
Resumotrue
Nomes alternativosPatient
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. AllergyIntolerance.patient.id
Definição

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

CurtoUnique id for inter-element referencing
Controlo0..1
Tipostring
É modificadorfalse
Formato XMLNo formato XML, esta propriedade é representada como um atributo.
Resumofalse
36. AllergyIntolerance.patient.extension
Definição

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.

CurtoAdditional content defined by implementations
Comentários

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.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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())
SlicingEste elemento introduz um conjunto de fatias em AllergyIntolerance.patient.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 38. AllergyIntolerance.patient.reference
    Definição

    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

    CurtoLiteral reference, Relative, internal or absolute URL
    Comentários

    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

    Controlo1..1
    Este elemento é afetado pelas seguintes invariantes: ref-1
    Tipostring
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. AllergyIntolerance.patient.type
    Definição

    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

    CurtoType the reference refers to (e.g. "Patient")
    Comentários

    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

    Controlo0..0
    VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceType
    (extensible to http://hl7.org/fhir/ValueSet/resource-types)

    Aa resource (or, for logical models, the URI of the logical model).

    Tipouri
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. AllergyIntolerance.patient.identifier
    Definição

    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

    CurtoLogical reference, when literal reference is not known
    Comentários

    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

    NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
    Controlo0..0
    TipoIdentifier
    É modificadorfalse
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. AllergyIntolerance.patient.display
    Definição

    Plain text narrative that identifies the resource in addition to the resource reference.

    CurtoText alternative for the resource
    Comentários

    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

    Controlo0..0
    Tipostring
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. AllergyIntolerance.encounter
    Definição

    The encounter when the allergy or intolerance was asserted.

    CurtoEncounter when the allergy or intolerance was asserted
    Controlo0..1
    TipoReference(Contato Assistencial)
    É modificadorfalse
    Resumofalse
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. AllergyIntolerance.encounter.id
    Definição

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    CurtoUnique id for inter-element referencing
    Controlo0..1
    Tipostring
    É modificadorfalse
    Formato XMLNo formato XML, esta propriedade é representada como um atributo.
    Resumofalse
    50. AllergyIntolerance.encounter.extension
    Definição

    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.

    CurtoAdditional content defined by implementations
    Comentários

    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.

    Controlo0..*
    TipoExtension
    É modificadorfalse
    Resumofalse
    Nomes alternativosextensions, user content
    Invariantesele-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())
    SlicingEste elemento introduz um conjunto de fatias em AllergyIntolerance.encounter.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 52. AllergyIntolerance.encounter.reference
      Definição

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      CurtoLiteral reference, Relative, internal or absolute URL
      Comentários

      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Controlo1..1
      Este elemento é afetado pelas seguintes invariantes: ref-1
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. AllergyIntolerance.encounter.type
      Definição

      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

      CurtoType the reference refers to (e.g. "Patient")
      Comentários

      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

      Controlo0..0
      VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceType
      (extensible to http://hl7.org/fhir/ValueSet/resource-types)

      Aa resource (or, for logical models, the URI of the logical model).

      Tipouri
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. AllergyIntolerance.encounter.identifier
      Definição

      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

      CurtoLogical reference, when literal reference is not known
      Comentários

      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

      NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
      Controlo0..0
      TipoIdentifier
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. AllergyIntolerance.encounter.display
      Definição

      Plain text narrative that identifies the resource in addition to the resource reference.

      CurtoText alternative for the resource
      Comentários

      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

      Controlo0..0
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      60. AllergyIntolerance.onset[x]
      Definição

      Estimated or actual date, date-time, or age when allergy or intolerance was identified.

      CurtoWhen allergy or intolerance was identified
      Controlo0..1
      TipoEscolha de: dateTime, Age, Period, Range, string
      [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      62. AllergyIntolerance.recordedDate
      Definição

      The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

      CurtoDate first version of the resource instance was recorded
      Controlo0..1
      TipodateTime
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. AllergyIntolerance.recorder
      Definição

      Individual who recorded the record and takes responsibility for its content.

      CurtoWho recorded the sensitivity
      Controlo0..0
      TipoReference(Practitioner, PractitionerRole, Patient, RelatedPerson)
      É modificadorfalse
      Resumofalse
      Nomes alternativosAuthor
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      66. AllergyIntolerance.asserter
      Definição

      The source of the information about the allergy that is recorded.

      CurtoSource of the information about the allergy
      Comentários

      The recorder takes responsibility for the content, but can reference the source from where they got it.

      Controlo0..0
      TipoReference(Patient, RelatedPerson, Practitioner, PractitionerRole)
      É modificadorfalse
      Resumotrue
      Nomes alternativosSource, Informant
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. AllergyIntolerance.lastOccurrence
      Definição

      Represents the date and/or time of the last known occurrence of a reaction event.

      CurtoDate(/time) of last known occurrence of a reaction
      Comentários

      This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

      Controlo0..0
      TipodateTime
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. AllergyIntolerance.note
      Definição

      Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

      CurtoAdditional text not captured in other fields
      Comentários

      For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

      Controlo0..*
      TipoAnnotation
      É modificadorfalse
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. AllergyIntolerance.note.id
      Definição

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      CurtoUnique id for inter-element referencing
      Controlo0..1
      Tipostring
      É modificadorfalse
      Formato XMLNo formato XML, esta propriedade é representada como um atributo.
      Resumofalse
      74. AllergyIntolerance.note.extension
      Definição

      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.

      CurtoAdditional content defined by implementations
      Comentários

      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.

      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Nomes alternativosextensions, user content
      Invariantesele-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())
      SlicingEste elemento introduz um conjunto de fatias em AllergyIntolerance.note.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
      • value @ url
      • 76. AllergyIntolerance.note.author[x]
        Definição

        The individual responsible for making the annotation.

        CurtoIndividual responsible for the annotation
        Comentários

        Organization is used when there's no need for specific attribution as to who made the comment.

        Controlo0..0
        TipoEscolha de: Reference(Practitioner, Patient, RelatedPerson, Organization), string
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        78. AllergyIntolerance.note.time
        Definição

        Indicates when this particular annotation was made.

        CurtoWhen the annotation was made
        Controlo0..0
        TipodateTime
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        80. AllergyIntolerance.note.text
        Definição

        The text of the annotation in markdown format.

        CurtoThe annotation - text content (as markdown)
        Controlo1..1
        Tipomarkdown
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumotrue
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. AllergyIntolerance.reaction
        Definição

        Details about each adverse reaction event linked to exposure to the identified substance.

        CurtoAdverse Reaction Events linked to exposure to substance
        Controlo0..*
        TipoBackboneElement
        É modificadorfalse
        Resumofalse
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. AllergyIntolerance.reaction.id
        Definição

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        CurtoUnique id for inter-element referencing
        Controlo0..1
        Tipostring
        É modificadorfalse
        Formato XMLNo formato XML, esta propriedade é representada como um atributo.
        Resumofalse
        86. AllergyIntolerance.reaction.extension
        Definição

        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.

        CurtoAdditional content defined by implementations
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadorfalse
        Resumofalse
        Nomes alternativosextensions, user content
        Invariantesele-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())
        88. AllergyIntolerance.reaction.modifierExtension
        Definição

        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).

        CurtoExtensions that cannot be ignored even if unrecognized
        Comentários

        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.

        Controlo0..*
        TipoExtension
        É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Resumotrue
        Requisitos

        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.

        Nomes alternativosextensions, user content, modifiers
        Invariantesele-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())
        90. AllergyIntolerance.reaction.substance
        Definição

        Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

        CurtoSpecific substance or pharmaceutical product considered to be responsible for event
        Comentários

        Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.

        Controlo0..0
        VínculoPara exemplos de códigos, ver SubstanceCode
        (example to http://hl7.org/fhir/ValueSet/substance-code)

        Codes defining the type of the substance (including pharmaceutical products).

        TipoCodeableConcept
        É modificadorfalse
        Resumofalse
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        92. AllergyIntolerance.reaction.manifestation
        Definição

        Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

        CurtoClinical symptoms/signs associated with the Event
        Comentários

        Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.

        Controlo1..*
        VínculoOs códigos DEVERÃO ser retirados de https://terminologia.saude.gov.br/fhir/ValueSet/BRReacoesAdversasMedDRA
        (preferred to https://terminologia.saude.gov.br/fhir/ValueSet/BRReacoesAdversasMedDRA)
        TipoCodeableConcept
        É modificadorfalse
        Resumofalse
        Nomes alternativosSymptoms, Signs
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        94. AllergyIntolerance.reaction.description
        Definição

        Text description about the reaction as a whole, including details of the manifestation if required.

        CurtoDescription of the event as a whole
        Comentários

        Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.

        Controlo0..1
        Tipostring
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumofalse
        Nomes alternativosNarrative, Text
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        96. AllergyIntolerance.reaction.onset
        Definição

        Record of the date and/or time of the onset of the Reaction.

        CurtoDate(/time) when manifestations showed
        Controlo0..0
        TipodateTime
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumofalse
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        98. AllergyIntolerance.reaction.severity
        Definição

        Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

        Curtomild | moderate | severe (of event as a whole)
        Comentários

        It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.

        Controlo0..0
        VínculoOs códigos DEVERÃO ser retirados de AllergyIntoleranceSeverity
        (required to http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1)

        Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

        Tipocode
        É modificadorfalse
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Resumofalse
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        100. AllergyIntolerance.reaction.exposureRoute
        Definição

        Identification of the route by which the subject was exposed to the substance.

        CurtoHow the subject was exposed to the substance
        Comentários

        Coding of the route of exposure with a terminology should be used wherever possible.

        Controlo0..0
        VínculoPara exemplos de códigos, ver SNOMEDCTRouteCodes
        (example to http://hl7.org/fhir/ValueSet/route-codes)

        A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

        TipoCodeableConcept
        É modificadorfalse
        Resumofalse
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        102. AllergyIntolerance.reaction.note
        Definição

        Additional text about the adverse reaction event not captured in other fields.

        CurtoText about event not captured in other fields
        Comentários

        Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.

        Controlo0..0
        TipoAnnotation
        É modificadorfalse
        Resumofalse
        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))