Module health.fhir.r4.be.clinical100
ballerinax/health.fhir.r4.be.clinical100 Ballerina library
1.0.0
Ballerina package containing FHIR resource data models compliant with https://www.ehealth.fgov.be/standards/fhir/core-clinical/ implementation guide.
FHIR R4 health_fhir_r4_be_clinical100 package
Package Overview
| FHIR version | R4 |
| Implementation Guide | https://www.ehealth.fgov.be/standards/fhir/core-clinical/ |
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). BeScoreResult | [Definition] [Ballerina Record] |
| 2). BeObservation | [Definition] [Ballerina Record] |
| 3). BeProblem | [Definition] [Ballerina Record] |
Functions
initialize
Isolated Function
function initialize()This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.be.clinical100: PROFILE_BASE_BEOBSERVATION
health.fhir.r4.be.clinical100: PROFILE_BASE_BEPROBLEM
health.fhir.r4.be.clinical100: PROFILE_BASE_BESCORERESULT
health.fhir.r4.be.clinical100: RESOURCE_NAME_BEOBSERVATION
health.fhir.r4.be.clinical100: RESOURCE_NAME_BEPROBLEM
health.fhir.r4.be.clinical100: RESOURCE_NAME_BESCORERESULT
Enums
health.fhir.r4.be.clinical100: BeObservationStatus
BeObservationStatus enum
Members
CODE_STATUS_AMENDED
CODE_STATUS_FINAL
CODE_STATUS_REGISTERED
CODE_STATUS_PRELIMINARY
health.fhir.r4.be.clinical100: BeScoreResultStatus
BeScoreResultStatus enum
Members
CODE_STATUS_AMENDED
CODE_STATUS_FINAL
CODE_STATUS_REGISTERED
CODE_STATUS_PRELIMINARY
Variables
health.fhir.r4.be.clinical100: terminologyProcessor
Terminology processor instance
health.fhir.r4.be.clinical100: fhirRegistry
FHIR registry instance
health.fhir.r4.be.clinical100: FHIR_VALUE_SETS
health.fhir.r4.be.clinical100: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.be.clinical100: BeObservation
FHIR BeObservation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEOBSERVATION(default RESOURCE_NAME_BEOBSERVATION) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- 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.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code BeObservationcodeableconcept - Describes what was observed. Sometimes this is called the observation 'name'. For providing systems, it is RECOMMENDED to express this using a code and consuming software SHALL record this. In general, it shall be noted SNOMED-CT is the preferred national terminology. Other coding systems remain allowed or MAY be preferred in specific flows (e.g. the use of LOINC codes to express a laboratory test.)
- subject? Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focuselement or thecodeitself specifies the actual focus of the observation.
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- 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).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- 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.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer Reference[] - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod? Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- effectiveTiming? Timing - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component? BeObservationComponent[] - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- 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.
- referenceRange? BeObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRangeelements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime? dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- 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.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- 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? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- effectiveInstant? instant - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- status BeObservationStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.be.clinical100: BeObservationcodeableconcept
Closed record
Fields
- Fields Included from *CodeableConcept
- id? string -
- extension? Extension[] -
- coding? Coding[] -
- system uri -
- 'version? string -
- code code -
- userSelected? boolean -
- display? string -
- text? string -
health.fhir.r4.be.clinical100: BeObservationComponent
Closed record
FHIR BeObservationComponent datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- 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.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- 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).
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.be.clinical100: BeObservationReferenceRange
Closed record
FHIR BeObservationReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- 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.
- high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
- low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
- 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).
- appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple
appliesToare interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.
- 'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
- age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
health.fhir.r4.be.clinical100: BeProblem
FHIR BeProblem resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEPROBLEM(default RESOURCE_NAME_BEPROBLEM) - The type of the resource describes
- note? Annotation[] - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
- extension? Extension[] - An Extension
- code CodeableConcept - Identification of the condition, problem or diagnosis.
- evidence? BeProblemEvidence[] - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
- onsetRange? Range - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- abatementDateTime? dateTime - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- subject Reference - Indicates the patient or group who the condition record is associated with.
- 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).
- language? code - The base language in which the resource is written.
- clinicalStatus? CodeableConcept - The clinical status of the condition.
- onsetDateTime? dateTime - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- onsetString? string - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- onsetAge? Age - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- abatementPeriod? Period - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- 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.
- abatementString? string - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- severity? CodeableConcept - A subjective assessment of the severity of the condition as evaluated by the clinician.
- identifier? Identifier[] - Business identifiers assigned to this condition 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.
- onsetPeriod? Period - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- verificationStatus? CodeableConcept - The verification status to support the clinical status of the condition.
- recordedDate dateTime - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
- abatementRange? Range - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- encounter? Reference - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
- bodySite? BeProblemBodySite[] - The anatomical location where this condition manifests itself.
- 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 - Individual who is making the condition statement.
- stage? BeProblemStage[] - Clinical stage or grade of a condition. May include formal severity assessments.
- 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 CodeableConcept[] - A category assigned to the condition.
- abatementAge? Age - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- Element... - Rest field
health.fhir.r4.be.clinical100: BeProblemBodySite
Closed record
FHIR BeProblemBodySite datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? Coding[] - A reference to a code defined by a terminology system.
- 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.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.clinical100: BeProblemEvidence
Closed record
FHIR BeProblemEvidence datatype record.
Fields
- Fields Included from *BackboneElement
- 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.
- code? CodeableConcept[] - A manifestation or symptom that led to the recording of this condition.
- 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).
- detail? Reference[] - Links to other relevant information, including pathology reports.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.be.clinical100: BeProblemStage
Closed record
FHIR BeProblemStage datatype record.
Fields
- Fields Included from *BackboneElement
- summary? CodeableConcept - A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific.
- assessment? Reference[] - Reference to a formal record of the evidence on which the staging assessment is based.
- 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.
- 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).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - The kind of staging, such as pathological or clinical staging.
health.fhir.r4.be.clinical100: BeScoreResult
FHIR BeScoreResult resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BESCORERESULT(default RESOURCE_NAME_BESCORERESULT) - The type of the resource describes
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.value[x] is missing.
- note? Annotation[] - Comments about the observation or the results.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- 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.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.
- subject Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focuselement or thecodeitself specifies the actual focus of the observation.
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- 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).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- 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.
- issued instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod? Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite? BeScoreResultBodySite - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component? BeScoreResultComponent[] - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- 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.
- referenceRange? BeScoreResultReferenceRange[] - The different ranges that the value can have, and corresponding evaluation (e.g. 0..10: normal; 11..20: elevated)
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- 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.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- 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? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- status BeScoreResultStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.be.clinical100: BeScoreResultBodySite
Closed record
FHIR BeScoreResultBodySite datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? Coding[] - A reference to a code defined by a terminology system.
- 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.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.clinical100: BeScoreResultComponent
Closed record
FHIR BeScoreResultComponent datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- 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.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- 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).
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.be.clinical100: BeScoreResultReferenceRange
Closed record
FHIR BeScoreResultReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- 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.
- high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
- low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
- 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).
- appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple
appliesToare interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.
- 'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
- age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
Import
import ballerinax/health.fhir.r4.be.clinical100;Other versions
1.0.0