Module health.fhir.r4.be.allergy100
ballerinax/health.fhir.r4.be.allergy100 Ballerina library
1.0.0
Ballerina package containing FHIR resource data models compliant with https://www.ehealth.fgov.be/standards/fhir/allergy/ implementation guide.
FHIR R4 health_fhir_r4_be_allergy100 package
Package Overview
| FHIR version | R4 |
| Implementation Guide | https://www.ehealth.fgov.be/standards/fhir/allergy/ |
Note: This package only supports FHIR JSON payload format only. FHIR XML payload support will be added soon.
Capabilities and features
Supported FHIR resource types
| 1). BeAllergyIntolerance | [Definition] [Ballerina Record] |
Functions
initialize
Isolated Function
function initialize()This empty function is used to initialize the module by other modules/packages.
Constants
Enums
health.fhir.r4.be.allergy100: BeAllergyIntoleranceCategory
BeAllergyIntoleranceCategory enum
Members
CODE_CATEGORY_ENVIRONMENT
CODE_CATEGORY_BIOLOGIC
CODE_CATEGORY_MEDICATION
CODE_CATEGORY_FOOD
health.fhir.r4.be.allergy100: BeAllergyIntoleranceCriticality
BeAllergyIntoleranceCriticality enum
Members
CODE_CRITICALITY_HIGH
CODE_CRITICALITY_LOW
CODE_CRITICALITY_UNABLE_TO_ASSESS
health.fhir.r4.be.allergy100: BeAllergyIntoleranceReactionSeverity
BeAllergyIntoleranceReactionSeverity enum
Members
CODE_SEVERITY_MILD
CODE_SEVERITY_SEVERE
CODE_SEVERITY_MODERATE
health.fhir.r4.be.allergy100: BeAllergyIntoleranceType
BeAllergyIntoleranceType enum
Members
CODE_TYPE_INTOLERANCE
CODE_TYPE_ALLERGY
Variables
health.fhir.r4.be.allergy100: terminologyProcessor
Terminology processor instance
health.fhir.r4.be.allergy100: fhirRegistry
FHIR registry instance
health.fhir.r4.be.allergy100: FHIR_VALUE_SETS
health.fhir.r4.be.allergy100: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.be.allergy100: BeAllergyIntolerance
FHIR BeAllergyIntolerance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEALLERGYINTOLERANCE(default RESOURCE_NAME_BEALLERGYINTOLERANCE) - The type of the resource describes
- note? Annotation[] - Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
- extension? Extension[] - 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.
- code CodeableConcept - 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. A provider SHALL include it in the istance and a consumer SHALL record this in its consuming system. If needed codes can be used outside the given valueset, SNOMED-CT is preferred.
- onsetRange? Range - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- modifierExtension? Extension[] - 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).
- criticality? BeAllergyIntoleranceCriticality - Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
- language? code - The base language in which the resource is written.
- clinicalStatus? CodeableConcept - The clinical status of the allergy or intolerance. When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.
- onsetDateTime? dateTime - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- 'type? BeAllergyIntoleranceType - Identification of the underlying physiological mechanism for the reaction risk. When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.
- onsetString? string - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- onsetAge? Age - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- lastOccurrence? dateTime - Represents the date and/or time of the last known occurrence of a reaction event.
- patient Reference - The patient who has the allergy or intolerance. A provider SHALL include it in the istance and a consumer SHALL record this in its consuming system.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- identifier? Identifier[] - 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.
- recorder Reference - Individual who recorded the record and takes responsibility for its content. A provider SHALL include it in the istance and a consumer SHALL record this in its consuming system.
- onsetPeriod? Period - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- reaction? BeAllergyIntoleranceReaction[] - Details about each adverse reaction event linked to exposure to the identified substance. When available, a provider SHOULD include it in the istance. When given, a consumer SHALL record this in its consuming system.
- verificationStatus? CodeableConcept - Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.
- recordedDate dateTime - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. A provider SHALL include it in the istance and a consumer SHALL record this in its consuming system.
- encounter? Reference - The encounter when the allergy or intolerance was asserted.
- contained? Resource[] - 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.
- asserter? Reference - The source of the information about the allergy that is recorded. When available, a provider SHOULD include it in the istance. When given, a consumer SHALL record this in its consuming system.
- meta? Meta - 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.
- implicitRules? uri - 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.
- category? BeAllergyIntoleranceCategory[] - Category of the identified substance. When available, a provider SHOULD include it in the istance. When given, a consumer SHALL record this in its consuming system.
- Element... - Rest field
health.fhir.r4.be.allergy100: BeAllergyIntoleranceReaction
Closed record
FHIR BeAllergyIntoleranceReaction datatype record.
Fields
- Fields Included from *BackboneElement
- severity? BeAllergyIntoleranceReactionSeverity - Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
- note? Annotation[] - Additional text about the adverse reaction event not captured in other fields. A note on this level SHOULD be avoided when not absolutely necessary. Preferably use the .note one level higher.
- extension? Extension[] - 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.
- manifestation CodeableConcept[] - Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system. If needed codes can be used outside the given valueset, SNOMED-CT is preferred.
- modifierExtension? Extension[] - 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).
- substance? CodeableConcept - 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.
- description? string - Text description about the reaction as a whole, including details of the manifestation if required.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- onset? dateTime - Record of the date and/or time of the onset of the Reaction.
- exposureRoute? CodeableConcept - Identification of the route by which the subject was exposed to the substance. If needed codes can be used outside the given valueset, SNOMED-CT is preferred.
Import
import ballerinax/health.fhir.r4.be.allergy100;Other versions
1.0.0