health.fhir.r4.aucore040
Module health.fhir.r4.aucore040
API
Declarations
Definitions
ballerinax/health.fhir.r4.aucore040 Ballerina library
Ballerina package containing FHIR resource data models compliant with http://hl7.org.au/fhir/core/ implementation guide.
FHIR R4 aucore040 package
Package Overview
FHIR version | R4 |
Implementation Guide | http://hl7.org.au/fhir/core/ |
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
Functions
initialize
function initialize()
This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREALLERGYINTOLERANCE
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREBLOODPRESSURE
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREBODYHEIGHT
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREBODYTEMPERATURE
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREBODYWEIGHT
health.fhir.r4.aucore040: PROFILE_BASE_AUCORECONDITION
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREDIAGNOSTICRESULT
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREENCOUNTER
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREHEARTRATE
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREIMMUNIZATION
health.fhir.r4.aucore040: PROFILE_BASE_AUCORELOCATION
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREMEDICATION
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREMEDICATIONREQUEST
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREORGANIZATION
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREPATHOLOGYRESULT
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREPATIENT
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREPRACTITIONER
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREPRACTITIONERROLE
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREPROCEDURE
health.fhir.r4.aucore040: PROFILE_BASE_AUCORERESPIRATIONRATE
health.fhir.r4.aucore040: PROFILE_BASE_AUCORESMOKINGSTATUS
health.fhir.r4.aucore040: PROFILE_BASE_AUCOREWAISTCIRCUMFERENCE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREALLERGYINTOLERANCE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREBLOODPRESSURE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREBODYHEIGHT
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREBODYTEMPERATURE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREBODYWEIGHT
health.fhir.r4.aucore040: RESOURCE_NAME_AUCORECONDITION
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREDIAGNOSTICRESULT
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREENCOUNTER
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREHEARTRATE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREIMMUNIZATION
health.fhir.r4.aucore040: RESOURCE_NAME_AUCORELOCATION
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREMEDICATION
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREMEDICATIONREQUEST
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREORGANIZATION
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREPATHOLOGYRESULT
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREPATIENT
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREPRACTITIONER
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREPRACTITIONERROLE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREPROCEDURE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCORERESPIRATIONRATE
health.fhir.r4.aucore040: RESOURCE_NAME_AUCORESMOKINGSTATUS
health.fhir.r4.aucore040: RESOURCE_NAME_AUCOREWAISTCIRCUMFERENCE
Enums
health.fhir.r4.aucore040: AUCoreAllergyIntoleranceCategory
AUCoreAllergyIntoleranceCategory enum
Members
health.fhir.r4.aucore040: AUCoreAllergyIntoleranceCriticality
AUCoreAllergyIntoleranceCriticality enum
Members
health.fhir.r4.aucore040: AUCoreAllergyIntoleranceReactionSeverity
AUCoreAllergyIntoleranceReactionSeverity enum
Members
health.fhir.r4.aucore040: AUCoreAllergyIntoleranceType
AUCoreAllergyIntoleranceType enum
Members
health.fhir.r4.aucore040: AUCoreBloodPressureComponentValueComparator
AUCoreBloodPressureComponentValueComparator enum
Members
health.fhir.r4.aucore040: AUCoreBloodPressureStatus
AUCoreBloodPressureStatus enum
Members
health.fhir.r4.aucore040: AUCoreBodyHeightStatus
AUCoreBodyHeightStatus enum
Members
health.fhir.r4.aucore040: AUCoreBodyHeightValueComparator
AUCoreBodyHeightValueComparator enum
Members
health.fhir.r4.aucore040: AUCoreBodyTemperatureStatus
AUCoreBodyTemperatureStatus enum
Members
health.fhir.r4.aucore040: AUCoreBodyTemperatureValueComparator
AUCoreBodyTemperatureValueComparator enum
Members
health.fhir.r4.aucore040: AUCoreBodyWeightStatus
AUCoreBodyWeightStatus enum
Members
health.fhir.r4.aucore040: AUCoreBodyWeightValueComparator
AUCoreBodyWeightValueComparator enum
Members
health.fhir.r4.aucore040: AUCoreDiagnosticResultStatus
AUCoreDiagnosticResultStatus enum
Members
health.fhir.r4.aucore040: AUCoreEncounterLocationStatus
AUCoreEncounterLocationStatus enum
Members
health.fhir.r4.aucore040: AUCoreEncounterStatus
AUCoreEncounterStatus enum
Members
health.fhir.r4.aucore040: AUCoreEncounterStatusHistoryStatus
AUCoreEncounterStatusHistoryStatus enum
Members
health.fhir.r4.aucore040: AUCoreHeartRateStatus
AUCoreHeartRateStatus enum
Members
health.fhir.r4.aucore040: AUCoreHeartRateValueComparator
AUCoreHeartRateValueComparator enum
Members
health.fhir.r4.aucore040: AUCoreImmunizationStatus
AUCoreImmunizationStatus enum
Members
health.fhir.r4.aucore040: AUCoreLocationHoursOfOperationDaysOfWeek
AUCoreLocationHoursOfOperationDaysOfWeek enum
Members
health.fhir.r4.aucore040: AUCoreLocationMode
AUCoreLocationMode enum
Members
health.fhir.r4.aucore040: AUCoreLocationStatus
AUCoreLocationStatus enum
Members
health.fhir.r4.aucore040: AUCoreMedicationRequestIntent
AUCoreMedicationRequestIntent enum
Members
health.fhir.r4.aucore040: AUCoreMedicationRequestPriority
AUCoreMedicationRequestPriority enum
Members
health.fhir.r4.aucore040: AUCoreMedicationRequestStatus
AUCoreMedicationRequestStatus enum
Members
health.fhir.r4.aucore040: AUCoreMedicationStatus
AUCoreMedicationStatus enum
Members
health.fhir.r4.aucore040: AUCorePathologyResultStatus
AUCorePathologyResultStatus enum
Members
health.fhir.r4.aucore040: AUCorePatientContactGender
AUCorePatientContactGender enum
Members
health.fhir.r4.aucore040: AUCorePatientGender
AUCorePatientGender enum
Members
health.fhir.r4.aucore040: AUCorePatientLinkType
AUCorePatientLinkType enum
Members
health.fhir.r4.aucore040: AUCorePatientNameUse
AUCorePatientNameUse enum
Members
health.fhir.r4.aucore040: AUCorePractitionerGender
AUCorePractitionerGender enum
Members
health.fhir.r4.aucore040: AUCorePractitionerNameUse
AUCorePractitionerNameUse enum
Members
health.fhir.r4.aucore040: AUCorePractitionerRoleAvailableTimeDaysOfWeek
AUCorePractitionerRoleAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.aucore040: AUCoreProcedureStatus
AUCoreProcedureStatus enum
Members
health.fhir.r4.aucore040: AUCoreRespirationRateStatus
AUCoreRespirationRateStatus enum
Members
health.fhir.r4.aucore040: AUCoreRespirationRateValueComparator
AUCoreRespirationRateValueComparator enum
Members
health.fhir.r4.aucore040: AUCoreSmokingStatusStatus
AUCoreSmokingStatusStatus enum
Members
health.fhir.r4.aucore040: AUCoreWaistCircumferenceStatus
AUCoreWaistCircumferenceStatus enum
Members
health.fhir.r4.aucore040: AUCoreWaistCircumferenceValueComparator
AUCoreWaistCircumferenceValueComparator enum
Members
Variables
health.fhir.r4.aucore040: terminologyProcessor
Terminology processor instance
health.fhir.r4.aucore040: fhirRegistry
FHIR registry instance
health.fhir.r4.aucore040: FHIR_VALUE_SETS
health.fhir.r4.aucore040: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.aucore040: AUCoreAllergyIntolerance
FHIR AUCoreAllergyIntolerance resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREALLERGYINTOLERANCE(default RESOURCE_NAME_AUCOREALLERGYINTOLERANCE) - 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.
- 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? AUCoreAllergyIntoleranceCriticality - 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.
- onsetDateTime? dateTime - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- 'type? AUCoreAllergyIntoleranceType - Identification of the underlying physiological mechanism for the reaction risk.
- 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.
- 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.
- onsetPeriod? Period - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- reaction? AUCoreAllergyIntoleranceReaction[] - Details about each adverse reaction event linked to exposure to the identified substance.
- verificationStatus? CodeableConcept - Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
- recordedDate? dateTime - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
- 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.
- 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? AUCoreAllergyIntoleranceCategory[] - Category of the identified substance.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreAllergyIntoleranceReaction
FHIR AUCoreAllergyIntoleranceReaction datatype record.
Fields
- severity? AUCoreAllergyIntoleranceReactionSeverity - 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.
- 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.
- 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.
health.fhir.r4.aucore040: AUCoreBloodPressure
FHIR AUCoreBloodPressure resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREBLOODPRESSURE(default RESOURCE_NAME_AUCOREBLOODPRESSURE) - The type of the resource describes
- 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.
- code AUCoreBloodPressureCode - Blood Pressure.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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 - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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 AUCoreBloodPressureComponent[] - Used when reporting systolic and diastolic blood pressure.
- component Slicings
- AUCoreBloodPressureComponentSystolicBP: Systolic Blood Pressure
- min = 1
- max = 1
- 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? AUCoreBloodPressureReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreBloodPressureCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreBloodPressureStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreBloodPressureCategoryCoding
FHIR AUCoreBloodPressureCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBloodPressureCategoryVSCat
FHIR AUCoreBloodPressureCategoryVSCat datatype record.
Fields
- coding AUCoreBloodPressureCategoryCoding[] - 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.aucore040: AUCoreBloodPressureCode
FHIR AUCoreBloodPressureCode datatype record.
Fields
- 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.aucore040: AUCoreBloodPressureCodeCodingBPCode
FHIR AUCoreBloodPressureCodeCodingBPCode datatype record.
Fields
- 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 code(default "85354-9") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBloodPressureCodeCodingSnomedBPCode
FHIR AUCoreBloodPressureCodeCodingSnomedBPCode datatype record.
Fields
- 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 code(default "75367002") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBloodPressureComponent
FHIR AUCoreBloodPressureComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreBloodPressureComponentCode
FHIR AUCoreBloodPressureComponentCode datatype record.
Fields
- coding Coding[] - Systolic Blood Pressure.
- 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.aucore040: AUCoreBloodPressureComponentCodeOne
FHIR AUCoreBloodPressureComponentCodeOne datatype record.
Fields
- coding Coding[] - Diastolic Blood Pressure.
- 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.aucore040: AUCoreBloodPressureComponentDiastolicBP
FHIR AUCoreBloodPressureComponentDiastolicBP datatype record.
Fields
- 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.
- code AUCoreBloodPressureComponentCodeOne - Describes what was observed. Sometimes this is called the observation 'code'.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- 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.
- valueQuantity? AUCoreBloodPressureComponentValue - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreBloodPressureComponentSystolicBP
FHIR AUCoreBloodPressureComponentSystolicBP datatype record.
Fields
- 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.
- code AUCoreBloodPressureComponentCode - Describes what was observed. Sometimes this is called the observation 'code'.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- 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.
- valueQuantity? AUCoreBloodPressureComponentValue - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreBloodPressureComponentValue
FHIR AUCoreBloodPressureComponentValue datatype record.
Fields
- comparator? AUCoreBloodPressureComponentValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- unit string - A human-readable form of the unit.
- code code(default "mm[Hg]") - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
health.fhir.r4.aucore040: AUCoreBloodPressureReferenceRange
FHIR AUCoreBloodPressureReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreBodyHeight
FHIR AUCoreBodyHeight resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREBODYHEIGHT(default RESOURCE_NAME_AUCOREBODYHEIGHT) - The type of the resource describes
- 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.
- code AUCoreBodyHeightCode - Body Height.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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? AUCoreBodyHeightValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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? AUCoreBodyHeightComponent[] - Used when reporting systolic and diastolic blood pressure.
- 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? AUCoreBodyHeightReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreBodyHeightCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreBodyHeightStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreBodyHeightCategoryCoding
FHIR AUCoreBodyHeightCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyHeightCategoryVSCat
FHIR AUCoreBodyHeightCategoryVSCat datatype record.
Fields
- coding AUCoreBodyHeightCategoryCoding[] - 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.aucore040: AUCoreBodyHeightCode
FHIR AUCoreBodyHeightCode datatype record.
Fields
- 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.aucore040: AUCoreBodyHeightCodeCodingBodyHeightCode
FHIR AUCoreBodyHeightCodeCodingBodyHeightCode datatype record.
Fields
- 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 code(default "8302-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyHeightCodeCodingSnomedBodyHeightCode
FHIR AUCoreBodyHeightCodeCodingSnomedBodyHeightCode datatype record.
Fields
- 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 code(default "50373000") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyHeightComponent
FHIR AUCoreBodyHeightComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreBodyHeightReferenceRange
FHIR AUCoreBodyHeightReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreBodyHeightValue
FHIR AUCoreBodyHeightValue datatype record.
Fields
- comparator? AUCoreBodyHeightValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- 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.
- unit string - A human-readable form of the unit.
- code code - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
health.fhir.r4.aucore040: AUCoreBodyTemperature
FHIR AUCoreBodyTemperature resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREBODYTEMPERATURE(default RESOURCE_NAME_AUCOREBODYTEMPERATURE) - The type of the resource describes
- 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.
- code AUCoreBodyTemperatureCode - Body Temperature.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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? AUCoreBodyTemperatureValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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? AUCoreBodyTemperatureComponent[] - Used when reporting systolic and diastolic blood pressure.
- 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? AUCoreBodyTemperatureReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreBodyTemperatureCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreBodyTemperatureStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreBodyTemperatureCategoryCoding
FHIR AUCoreBodyTemperatureCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyTemperatureCategoryVSCat
FHIR AUCoreBodyTemperatureCategoryVSCat datatype record.
Fields
- coding AUCoreBodyTemperatureCategoryCoding[] - 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.aucore040: AUCoreBodyTemperatureCode
FHIR AUCoreBodyTemperatureCode datatype record.
Fields
- 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.aucore040: AUCoreBodyTemperatureCodeCodingBodyTempCode
FHIR AUCoreBodyTemperatureCodeCodingBodyTempCode datatype record.
Fields
- 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 code(default "8310-5") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyTemperatureCodeCodingSnomedBodyTempCode
FHIR AUCoreBodyTemperatureCodeCodingSnomedBodyTempCode datatype record.
Fields
- 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 code(default "386725007") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyTemperatureComponent
FHIR AUCoreBodyTemperatureComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreBodyTemperatureReferenceRange
FHIR AUCoreBodyTemperatureReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreBodyTemperatureValue
FHIR AUCoreBodyTemperatureValue datatype record.
Fields
- comparator? AUCoreBodyTemperatureValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- 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.
- unit string - A human-readable form of the unit.
- code code - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
health.fhir.r4.aucore040: AUCoreBodyWeight
FHIR AUCoreBodyWeight resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREBODYWEIGHT(default RESOURCE_NAME_AUCOREBODYWEIGHT) - The type of the resource describes
- 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.
- code AUCoreBodyWeightCode - Body Weight.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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? AUCoreBodyWeightValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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? AUCoreBodyWeightComponent[] - Used when reporting systolic and diastolic blood pressure.
- 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? AUCoreBodyWeightReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreBodyWeightCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreBodyWeightStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreBodyWeightCategoryCoding
FHIR AUCoreBodyWeightCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyWeightCategoryVSCat
FHIR AUCoreBodyWeightCategoryVSCat datatype record.
Fields
- coding AUCoreBodyWeightCategoryCoding[] - 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.aucore040: AUCoreBodyWeightCode
FHIR AUCoreBodyWeightCode datatype record.
Fields
- 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.aucore040: AUCoreBodyWeightCodeCodingBodyWeightCode
FHIR AUCoreBodyWeightCodeCodingBodyWeightCode datatype record.
Fields
- 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 code(default "29463-7") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyWeightCodeCodingSnomedBodyWeightCode
FHIR AUCoreBodyWeightCodeCodingSnomedBodyWeightCode datatype record.
Fields
- 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 code(default "27113001") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreBodyWeightComponent
FHIR AUCoreBodyWeightComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreBodyWeightReferenceRange
FHIR AUCoreBodyWeightReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreBodyWeightValue
FHIR AUCoreBodyWeightValue datatype record.
Fields
- comparator? AUCoreBodyWeightValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- 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.
- unit string - A human-readable form of the unit.
- code code - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
health.fhir.r4.aucore040: AUCoreCondition
FHIR AUCoreCondition resource record.
Fields
- resourceType RESOURCE_NAME_AUCORECONDITION(default RESOURCE_NAME_AUCORECONDITION) - 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[] - 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 - Identification of the condition, problem or diagnosis.
- evidence? AUCoreConditionEvidence[] - 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.
- 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.
- 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? CodeableConcept[] - 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? AUCoreConditionStage[] - 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.aucore040: AUCoreConditionEvidence
FHIR AUCoreConditionEvidence datatype record.
Fields
- 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.aucore040: AUCoreConditionStage
FHIR AUCoreConditionStage datatype record.
Fields
- 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.aucore040: AUCoreDiagnosticResult
FHIR AUCoreDiagnosticResult resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREDIAGNOSTICRESULT(default RESOURCE_NAME_AUCOREDIAGNOSTICRESULT) - 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
focus
element or thecode
itself 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? AUCoreDiagnosticResultHasMember[] - 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? AUCoreDiagnosticResultComponent[] - 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? AUCoreDiagnosticResultReferenceRange[] - 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
referenceRange
elements 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 AUCoreDiagnosticResultStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreDiagnosticResultComponent
FHIR AUCoreDiagnosticResultComponent datatype record.
Fields
- 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.
- 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.aucore040: AUCoreDiagnosticResultHasMember
FHIR AUCoreDiagnosticResultHasMember datatype record.
Fields
- reference string - 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.
- identifier? Identifier - 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.
- 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.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- 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? uri - 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).
health.fhir.r4.aucore040: AUCoreDiagnosticResultReferenceRange
FHIR AUCoreDiagnosticResultReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreEncounter
FHIR AUCoreEncounter resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREENCOUNTER(default RESOURCE_NAME_AUCOREENCOUNTER) - The type of the resource describes
- serviceType? CodeableConcept - Broad categorization of the service that is to be provided (e.g. cardiology).
- partOf? Reference - Another Encounter of which this encounter is a part of (administratively or in time).
- extension? Extension[] - An Extension
- extension Slicings
- Extension: Associated healthcare service
- min = 0
- max = *
- subject Reference - The patient or group present at the encounter.
- 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).
- reasonReference? Reference[] - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- appointment? Reference[] - The appointment that scheduled this encounter.
- language? code - The base language in which the resource is written.
- 'type? CodeableConcept[] - Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
- participant? AUCoreEncounterParticipant[] - The list of people responsible for providing the service.
- episodeOfCare? Reference[] - Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- 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.
- 'class Coding - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
- basedOn? Reference[] - The request this encounter satisfies (e.g. incoming referral or procedure request).
- identifier? Identifier[] - Identifier(s) by which this encounter is known.
- period? Period - The start and end time of the encounter.
- classHistory? AUCoreEncounterClassHistory[] - The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
- hospitalization? AUCoreEncounterHospitalization - Details about the admission to a healthcare service.
- length? Duration - Quantity of time the encounter lasted. This excludes the time during leaves of absence.
- diagnosis? AUCoreEncounterDiagnosis[] - The list of diagnosis relevant to this encounter.
- priority? CodeableConcept - Indicates the urgency of the encounter.
- 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.
- statusHistory? AUCoreEncounterStatusHistory[] - The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
- 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.
- serviceProvider? Reference - The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
- 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.
- location? AUCoreEncounterLocation[] - List of locations where the patient has been during this encounter.
- account? Reference[] - The set of accounts that may be used for billing for this Encounter.
- status AUCoreEncounterStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreEncounterClassHistory
FHIR AUCoreEncounterClassHistory datatype record.
Fields
- 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.
- period Period - The time that the episode was in the specified class.
- 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.
- 'class Coding - inpatient | outpatient | ambulatory | emergency +.
health.fhir.r4.aucore040: AUCoreEncounterDiagnosis
FHIR AUCoreEncounterDiagnosis datatype record.
Fields
- condition Reference - Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
- 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.
- use? CodeableConcept - Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
- 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).
- rank? positiveInt - Ranking of the diagnosis (for each role type).
- 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.aucore040: AUCoreEncounterHospitalization
FHIR AUCoreEncounterHospitalization datatype record.
Fields
- 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.
- specialArrangement? CodeableConcept[] - Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
- reAdmission? CodeableConcept - Whether this hospitalization is a readmission and why if known.
- 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).
- origin? Reference - The location/organization from which the patient came before admission.
- destination? Reference - Location/organization to which the patient is discharged.
- dietPreference? CodeableConcept[] - Diet preferences reported by the patient.
- preAdmissionIdentifier? Identifier - Pre-admission identifier.
- specialCourtesy? CodeableConcept[] - Special courtesies (VIP, board member).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- dischargeDisposition? CodeableConcept - Category or kind of location after discharge.
- admitSource? CodeableConcept - From where patient was admitted (physician referral, transfer).
health.fhir.r4.aucore040: AUCoreEncounterLocation
FHIR AUCoreEncounterLocation datatype record.
Fields
- 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.
- period? Period - Time period during which the patient was present at the location.
- 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).
- physicalType? CodeableConcept - This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
- location Reference - The location where the encounter takes place.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- status? AUCoreEncounterLocationStatus - The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
health.fhir.r4.aucore040: AUCoreEncounterParticipant
FHIR AUCoreEncounterParticipant datatype record.
Fields
- 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.
- period? Period - The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
- individual? Reference - Persons involved in the encounter other than the patient.
- 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[] - Role of participant in encounter.
health.fhir.r4.aucore040: AUCoreEncounterStatusHistory
FHIR AUCoreEncounterStatusHistory datatype record.
Fields
- 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.
- period Period - The time that the episode was in the specified status.
- 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.
- status AUCoreEncounterStatusHistoryStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
health.fhir.r4.aucore040: AUCoreHeartRate
FHIR AUCoreHeartRate resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREHEARTRATE(default RESOURCE_NAME_AUCOREHEARTRATE) - The type of the resource describes
- 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.
- code AUCoreHeartRateCode - Heart Rate.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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? AUCoreHeartRateValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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? AUCoreHeartRateComponent[] - Used when reporting systolic and diastolic blood pressure.
- 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? AUCoreHeartRateReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreHeartRateCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreHeartRateStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreHeartRateCategoryCoding
FHIR AUCoreHeartRateCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreHeartRateCategoryVSCat
FHIR AUCoreHeartRateCategoryVSCat datatype record.
Fields
- coding AUCoreHeartRateCategoryCoding[] - 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.aucore040: AUCoreHeartRateCode
FHIR AUCoreHeartRateCode datatype record.
Fields
- 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.aucore040: AUCoreHeartRateCodeCodingHeartRateCode
FHIR AUCoreHeartRateCodeCodingHeartRateCode datatype record.
Fields
- 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 code(default "8867-4") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreHeartRateCodeCodingSnomedHeartRateCode
FHIR AUCoreHeartRateCodeCodingSnomedHeartRateCode datatype record.
Fields
- 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 code(default "364075005") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreHeartRateComponent
FHIR AUCoreHeartRateComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreHeartRateReferenceRange
FHIR AUCoreHeartRateReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreHeartRateValue
FHIR AUCoreHeartRateValue datatype record.
Fields
- comparator? AUCoreHeartRateValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- 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.
- unit string - A human-readable form of the unit.
- code code(default "/min") - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
health.fhir.r4.aucore040: AUCoreImmunization
FHIR AUCoreImmunization resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREIMMUNIZATION(default RESOURCE_NAME_AUCOREIMMUNIZATION) - The type of the resource describes
- note? Annotation[] - Extra information about the immunization that is not conveyed by the other attributes.
- primarySource? boolean - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
- 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.
- education? AUCoreImmunizationEducation[] - Educational material presented to the patient (or guardian) at the time of vaccine administration.
- doseQuantity? SimpleQuantity - The quantity of vaccine product that was administered.
- 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).
- reasonReference? Reference[] - Condition, Observation or DiagnosticReport that supports why the immunization was administered.
- language? code - The base language in which the resource is written.
- manufacturer? Reference - Physical vaccine product manufacturer.
- programEligibility? CodeableConcept[] - Indicates a patient's eligibility for a funding program.
- statusReason? CodeableConcept - Indicates the reason the immunization event was not performed.
- isSubpotent? boolean - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
- patient Reference - The patient who either received or did not receive the immunization.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - Reasons why the vaccine was administered.
- 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.
- vaccineCode AUCoreImmunizationVaccineCode - Vaccine that was administered or was to be administered.
- expirationDate? date - Date vaccine batch expires.
- identifier? Identifier[] - A unique identifier assigned to this immunization record.
- performer? AUCoreImmunizationPerformer[] - Indicates who performed the immunization event.
- performer Slicings
- AUCoreImmunizationPerformerApprovedBy: Immunisation Approved By
- min = 0
- max = 1
- reaction? AUCoreImmunizationReaction[] - Categorical data indicating that an adverse event is associated in time to an immunization.
- subpotentReason? CodeableConcept[] - Reason why a dose is considered to be subpotent.
- encounter? Reference - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
- lotNumber? string - Lot number of the vaccine product.
- recorded? dateTime - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
- 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.
- site? CodeableConcept - Body site where vaccine was administered.
- route? CodeableConcept - The path by which the vaccine product is taken into the body.
- 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.
- protocolApplied? AUCoreImmunizationProtocolApplied[] - The protocol (set of recommendations) being followed by the provider who administered the dose.
- 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.
- reportOrigin? CodeableConcept - The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
- location? Reference - The service delivery location where the vaccine administration occurred.
- occurrenceDateTime dateTime - Date vaccine administered or was to be administered.
- occurrenceString string - Date vaccine administered or was to be administered.
- fundingSource? CodeableConcept - Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
- status AUCoreImmunizationStatus - Indicates the current status of the immunization event.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreImmunizationEducation
FHIR AUCoreImmunizationEducation datatype record.
Fields
- reference? uri - Reference pointer to the educational material given to the patient if the information was on line.
- 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.
- documentType? string - Identifier of the material presented to the patient.
- 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).
- presentationDate? dateTime - Date the educational material was given to the patient.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- publicationDate? dateTime - Date the educational material was published.
health.fhir.r4.aucore040: AUCoreImmunizationPerformer
FHIR AUCoreImmunizationPerformer datatype record.
Fields
- actor Reference - The practitioner or organization who performed the action.
- 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.
- 'function? CodeableConcept - Describes the type of performance (e.g. ordering provider, administering provider, etc.).
- 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.
health.fhir.r4.aucore040: AUCoreImmunizationPerformerAdministeredBy
FHIR AUCoreImmunizationPerformerAdministeredBy datatype record.
Fields
- actor Reference - The practitioner or organization who performed the action.
- 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.
- 'function AUCoreImmunizationPerformerFunctionOne - Describes the type of performance (e.g. ordering provider, administering provider, etc.).
- 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.
health.fhir.r4.aucore040: AUCoreImmunizationPerformerApprovedBy
FHIR AUCoreImmunizationPerformerApprovedBy datatype record.
Fields
- actor Reference - The practitioner or organization who performed the action.
- 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.
- 'function AUCoreImmunizationPerformerFunction - Describes the type of performance (e.g. ordering provider, administering provider, etc.).
- 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.
health.fhir.r4.aucore040: AUCoreImmunizationPerformerFunction
FHIR AUCoreImmunizationPerformerFunction datatype record.
Fields
- coding AUCoreImmunizationPerformerFunctionCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.aucore040: AUCoreImmunizationPerformerFunctionCoding
FHIR AUCoreImmunizationPerformerFunctionCoding datatype record.
Fields
- system uri(default "http://terminology.hl7.org/CodeSystem/v2-0443") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "OP") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.aucore040: AUCoreImmunizationPerformerFunctionCodingOne
FHIR AUCoreImmunizationPerformerFunctionCodingOne datatype record.
Fields
- system uri(default "http://terminology.hl7.org/CodeSystem/v2-0443") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "AP") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.aucore040: AUCoreImmunizationPerformerFunctionOne
FHIR AUCoreImmunizationPerformerFunctionOne datatype record.
Fields
- coding AUCoreImmunizationPerformerFunctionCodingOne[] - A reference to a code defined by a terminology system.
health.fhir.r4.aucore040: AUCoreImmunizationProtocolApplied
FHIR AUCoreImmunizationProtocolApplied datatype record.
Fields
- doseNumberString string - Nominal position in a series.
- 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.
- seriesDosesPositiveInt? positiveInt - The recommended number of doses to achieve immunity.
- series? string - One possible path to achieve presumed immunity against a disease - within the context of an authority.
- authority? Reference - Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
- doseNumberPositiveInt positiveInt - Nominal position in a series.
- 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).
- targetDisease? CodeableConcept[] - The vaccine preventable disease the dose is being administered against.
- seriesDosesString? string - The recommended number of doses to achieve immunity.
- 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.aucore040: AUCoreImmunizationReaction
FHIR AUCoreImmunizationReaction datatype record.
Fields
- date? dateTime - Date of reaction to the immunization.
- 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).
- reported? boolean - Self-reported indicator.
- detail? Reference - Details of the reaction.
- 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.aucore040: AUCoreImmunizationVaccineCode
FHIR AUCoreImmunizationVaccineCode datatype record.
Fields
- 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.aucore040: AUCoreImmunizationVaccineCodeCodingAirVaccineCode
FHIR AUCoreImmunizationVaccineCodeCodingAirVaccineCode datatype record.
Fields
- 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? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreImmunizationVaccineCodeCodingAmtVaccineCode
FHIR AUCoreImmunizationVaccineCodeCodingAmtVaccineCode datatype record.
Fields
- 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? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreLocation
FHIR AUCoreLocation resource record.
Fields
- resourceType RESOURCE_NAME_AUCORELOCATION(default RESOURCE_NAME_AUCORELOCATION) - The type of the resource describes
- operationalStatus? Coding - The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
- partOf? Reference - Another Location of which this Location is physically a part of.
- 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.
- 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).
- description? string - Description of the Location, which helps in finding or referencing the place.
- hoursOfOperation? AUCoreLocationHoursOfOperation[] - What days/times during a week is this location usually open.
- language? code - The base language in which the resource is written.
- 'type? CodeableConcept[] - Indicates the type of function performed at the location.
- mode? AUCoreLocationMode - Indicates whether a resource instance represents a specific location or a class of locations.
- endpoint? Reference[] - Technical endpoints providing access to services operated for the location.
- alias? string[] - A list of alternate names that the location is known as, or was known as, in the past.
- telecom? ContactPoint[] - The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
- 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? AuLocationspecificpracticenumber[]|Identifier[]|AuNatasitenumber[] - Unique code or number identifying the location to its users.
- address? AuAddress|Address - An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
- physicalType? CodeableConcept - Physical form of the location, e.g. building, room, vehicle, road.
- 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.
- managingOrganization? Reference - The organization responsible for the provisioning and upkeep of the location.
- 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.
- name? string - Name of the location as used by humans. Does not need to be unique.
- 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.
- position? AUCoreLocationPosition - The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
- availabilityExceptions? string - A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
- status? AUCoreLocationStatus - The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreLocationHoursOfOperation
FHIR AUCoreLocationHoursOfOperation datatype record.
Fields
- allDay? boolean - The Location is open all day.
- 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.
- closingTime? time - Time that the Location closes.
- 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).
- openingTime? time - Time that the Location opens.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- daysOfWeek? AUCoreLocationHoursOfOperationDaysOfWeek[] - Indicates which days of the week are available between the start and end Times.
health.fhir.r4.aucore040: AUCoreLocationPosition
FHIR AUCoreLocationPosition datatype record.
Fields
- altitude? decimal - Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
- 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.
- latitude decimal - Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
- 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.
- longitude decimal - Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
health.fhir.r4.aucore040: AUCoreMedication
FHIR AUCoreMedication resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREMEDICATION(default RESOURCE_NAME_AUCOREMEDICATION) - The type of the resource describes
- identifier? Identifier[] - Business identifier for this medication.
- amount? Ratio - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
- extension? Extension[] - An Extension
- code AUCoreMedicationCode - A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
- ingredient? AUCoreMedicationIngredient[] - Identifies a particular constituent of interest in the product. Can be coded with AMT.
- 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).
- batch? AUCoreMedicationBatch - Information that only applies to packages (not products).
- language? code - The base language in which the resource is written.
- manufacturer? Reference - Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product it is the manufacturer of the actual physical medicine product.
- 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.
- form? CodeableConcept - Describes the form of the item. Powder; tablets; capsule.
- 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.
- 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.
- status? AUCoreMedicationStatus - A code to indicate if the medication is in active use.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreMedicationBatch
FHIR AUCoreMedicationBatch datatype record.
Fields
- 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.
- lotNumber? string - The assigned lot number of a batch of the specified product.
- expirationDate? dateTime - When this specific batch of product will expire.
health.fhir.r4.aucore040: AUCoreMedicationCode
FHIR AUCoreMedicationCode datatype record.
Fields
- 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. This may be a brand or generic name as suitable for the intent of the entry.
health.fhir.r4.aucore040: AUCoreMedicationCodeCodingAmt
FHIR AUCoreMedicationCodeCodingAmt datatype record.
Fields
- extension? Extension[] - An Extension
- code? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreMedicationCodeCodingGtin
FHIR AUCoreMedicationCodeCodingGtin datatype record.
Fields
- 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? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://www.gs1.org/gtin") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreMedicationCodeCodingMimsPackage
FHIR AUCoreMedicationCodeCodingMimsPackage datatype record.
Fields
- 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? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://www.mims.com.au/codes") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreMedicationCodeCodingPbs
FHIR AUCoreMedicationCodeCodingPbs datatype record.
Fields
- 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? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://pbs.gov.au/code/item") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreMedicationIngredient
FHIR AUCoreMedicationIngredient datatype record.
Fields
- itemReference Reference - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
- 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.
- strength? Ratio - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
- itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
- 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.
- isActive? boolean - Indication of whether this ingredient affects the therapeutic action of the drug.
health.fhir.r4.aucore040: AUCoreMedicationRequest
FHIR AUCoreMedicationRequest resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREMEDICATIONREQUEST(default RESOURCE_NAME_AUCOREMEDICATIONREQUEST) - The type of the resource describes
- insurance? Reference[] - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
- note? Annotation[] - Extra information about the prescription that could not be conveyed by the other attributes.
- extension? Extension[] - An Extension
- extension Slicings
- Extension: Grounds for concurrent supply of medication
- min = 0
- max = 1
- substitution? AUCoreMedicationRequestSubstitution - Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
- courseOfTherapyType? CodeableConcept - The description of the overall patte3rn of the administration of the medication to the patient.
- priorPrescription? Reference - A link to a resource representing an earlier order related order or prescription.
- subject Reference - A link to a resource representing the person or set of individuals to whom the medication will be given.
- 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).
- reasonReference? Reference[] - Condition or observation that supports why the medication was ordered.
- language? code - The base language in which the resource is written.
- instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
- medicationReference? Reference - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- reportedReference? Reference - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- statusReason? CodeableConcept - Captures the reason for the current state of the MedicationRequest.
- dispenseRequest? AUCoreMedicationRequestDispenseRequest - Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - The reason or the indication for ordering or not ordering the medication.
- 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.
- doNotPerform? boolean - If true indicates that the provider is asking for the medication request not to occur.
- basedOn? Reference[] - A plan or request that is fulfilled in whole or in part by this medication request.
- requester Reference - The individual, organization, or device that initiated the request and has responsibility for its activation.
- identifier? Identifier[]|AuEtpprescriptionidentifier[]|AuLocalprescriptionidentifier[] - Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- recorder? Reference - The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
- reportedBoolean? boolean - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- authoredOn dateTime - The date (and perhaps time) when the prescription was initially written or authored on.
- performer? Reference - The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
- detectedIssue? Reference[] - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
- supportingInformation? Reference[] - Include additional information (for example, patient height and weight) that supports the ordering of the medication.
- supportingInformation Slicings
- AUCoreMedicationRequestSupportingInformationBodyHeight: Observation of Body Height
- min = 0
- max = 1
- encounter? Reference - The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
- instantiatesCanonical? canonical[] - The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
- medicationCodeableConcept? CodeableConcept - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- priority? AUCoreMedicationRequestPriority - Indicates how quickly the Medication Request should be addressed with respect to other requests.
- intent AUCoreMedicationRequestIntent - Whether the request is a proposal, plan, or an original order.
- performerType? CodeableConcept - Indicates the type of performer of the administration of the medication.
- 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.
- dosageInstruction? AuDosage[] - Indicates how the medication is/was taken or should be taken by the patient.
- 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.
- eventHistory? Reference[] - Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of 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[] - Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- groupIdentifier? Identifier - A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
- status AUCoreMedicationRequestStatus - A code specifying the current state of the order. Generally, this will be active or completed state.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreMedicationRequestDispenseRequest
FHIR AUCoreMedicationRequestDispenseRequest datatype record.
Fields
- validityPeriod? Period - This indicates the validity period of a prescription (stale dating the Prescription).
- dispenseInterval? Duration - The minimum period of time that must occur between dispenses of the medication.
- 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.
- performer? Reference - Indicates the intended dispensing Organization specified by the prescriber.
- quantity? Quantity - The amount that is to be dispensed for one fill.
- numberOfRepeatsAllowed? unsignedInt - An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus '3 repeats', then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.
- 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).
- initialFill? AUCoreMedicationRequestDispenseRequestInitialFill - Indicates the quantity or duration for the first dispense of the medication.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- expectedSupplyDuration? Duration - Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
health.fhir.r4.aucore040: AUCoreMedicationRequestDispenseRequestInitialFill
FHIR AUCoreMedicationRequestDispenseRequestInitialFill datatype record.
Fields
- duration? Duration - The length of time that the first dispense is expected to last.
- 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.
- quantity? Quantity - The amount or quantity to provide as part of the first dispense.
- 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.
health.fhir.r4.aucore040: AUCoreMedicationRequestSubstitution
FHIR AUCoreMedicationRequestSubstitution datatype record.
Fields
- allowedCodeableConcept CodeableConcept - True if the prescriber allows a different drug to be dispensed from what was prescribed.
- reason? CodeableConcept - Indicates the reason for the substitution, or why substitution must or must not be performed.
- 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).
- allowedBoolean boolean - True if the prescriber allows a different drug to be dispensed from what was prescribed.
- 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.aucore040: AUCoreMedicationRequestSupportingInformationBodyHeight
FHIR AUCoreMedicationRequestSupportingInformationBodyHeight datatype record.
health.fhir.r4.aucore040: AUCoreMedicationRequestSupportingInformationBodyWeight
FHIR AUCoreMedicationRequestSupportingInformationBodyWeight datatype record.
health.fhir.r4.aucore040: AUCoreOrganization
FHIR AUCoreOrganization resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREORGANIZATION(default RESOURCE_NAME_AUCOREORGANIZATION) - The type of the resource describes
- identifier? AuPharmacyapprovalnumber[]|AuAustralianregistredbodynumber[]|Identifier[]|AuPaioidentifier[]|AuAustraliancompanynumber[]|AuNataaccreditationnumber[]|AuCspregistrationnumber[]|AuAustralianbusinessnumber[]|AuHpio[] - Identifier for the organization that is used to identify the organization across multiple disparate systems.
- identifier Slicings
- AUCoreOrganizationIdentifierAbn: Australian Business Number (ABN)
- min = 0
- max = *
- partOf? Reference - The organization of which this organization forms a part.
- 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.
- address? AuAddress[]|Address[] - An address for the organization.
- 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).
- active? boolean - Whether the organization's record is still in active use.
- language? code - The base language in which the resource is written.
- 'type? CodeableConcept[] - The kind(s) of organization that this is.
- 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.
- endpoint? Reference[] - Technical endpoints providing access to services operated for the organization.
- 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.
- contact? AUCoreOrganizationContact[] - Contact for the organization for a certain purpose.
- name string - A name associated with the organization.
- alias? string[] - A list of alternate names that the organization is known as, or was known as in the past.
- 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.
- telecom? ContactPoint[] - A contact detail for the organization.
- 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.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreOrganizationContact
FHIR AUCoreOrganizationContact datatype record.
Fields
- 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.
- address? Address - Visiting or postal addresses for the contact.
- purpose? CodeableConcept - Indicates a purpose for which the contact can be reached.
- 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).
- name? HumanName - A name associated with the contact.
- telecom? ContactPoint[] - A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
- 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.aucore040: AUCoreOrganizationIdentifierAbn
FHIR AUCoreOrganizationIdentifierAbn datatype record.
health.fhir.r4.aucore040: AUCoreOrganizationIdentifierHpio
FHIR AUCoreOrganizationIdentifierHpio datatype record.
health.fhir.r4.aucore040: AUCorePathologyResult
FHIR AUCorePathologyResult resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREPATHOLOGYRESULT(default RESOURCE_NAME_AUCOREPATHOLOGYRESULT) - 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
focus
element or thecode
itself 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? AUCorePathologyResultSpecimen - 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? AUCorePathologyResultHasMember[] - 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? AUCorePathologyResultComponent[] - 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? AUCorePathologyResultReferenceRange[] - 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
referenceRange
elements 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.
- category Slicings
- AUCorePathologyResultCategorySpecificDiscipline: Specific discipline of pathology
- min = 0
- max = *
- device? Reference - The device used to generate the observation data.
- status AUCorePathologyResultStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCorePathologyResultCategoryCoding
FHIR AUCorePathologyResultCategoryCoding datatype record.
Fields
- 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? code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/v2-0074") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCorePathologyResultCategoryCodingOne
FHIR AUCorePathologyResultCategoryCodingOne datatype record.
Fields
- 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 code(default "laboratory") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCorePathologyResultCategoryLab
FHIR AUCorePathologyResultCategoryLab datatype record.
Fields
- coding AUCorePathologyResultCategoryCodingOne[] - 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.aucore040: AUCorePathologyResultCategorySpecificDiscipline
FHIR AUCorePathologyResultCategorySpecificDiscipline datatype record.
Fields
- coding? AUCorePathologyResultCategoryCoding[] - 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.aucore040: AUCorePathologyResultComponent
FHIR AUCorePathologyResultComponent datatype record.
Fields
- 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.
- 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.aucore040: AUCorePathologyResultHasMember
FHIR AUCorePathologyResultHasMember datatype record.
Fields
- reference string - 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.
- identifier? Identifier - 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.
- 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.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- 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? uri - 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).
health.fhir.r4.aucore040: AUCorePathologyResultReferenceRange
FHIR AUCorePathologyResultReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCorePathologyResultSpecimen
FHIR AUCorePathologyResultSpecimen datatype record.
Fields
- reference string - 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.
- identifier? Identifier - 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.
- 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.
- display? string - Plain text narrative that identifies the resource in addition to the resource reference.
- 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? uri - 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).
health.fhir.r4.aucore040: AUCorePatient
FHIR AUCorePatient resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREPATIENT(default RESOURCE_NAME_AUCOREPATIENT) - The type of the resource describes
- extension? Extension[] - An Extension
- extension Slicings
- Extension: Indigenous status
- min = 0
- max = 1
- gender AUCorePatientGender - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
- 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).
- link? AUCorePatientLink[] - Link to a Patient or RelatedPerson resource that concerns the same actual person.
- language? code - The base language in which the resource is written.
- contact? AUCorePatientContact[] - A contact party (e.g. guardian, partner, friend) for the patient.
- deceasedDateTime? dateTime - Individual deceased date-time with optional accuracy indicator.
- generalPractitioner? Reference[] - Patient's nominated care provider.
- telecom? ContactPoint[] - A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
- 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.
- communication? AUCorePatientCommunication[] - A language which may be used to communicate with the patient about his or her health.
- identifier AuDvanumber[]|AuMedicarecardnumber[]|Identifier[]|AuIhi[]|AuMedicalrecordnumber[]|AuPensionerconcessioncardnumber[]|AuCwlthseniorshealthcardnumber[]|AuInsurancemembernumber[]|AuHealthcarecardnumber[] - An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- identifier Slicings
- AUCorePatientIdentifierDva: Department of Veterans' Affairs (DVA) Number
- min = 0
- max = 1
- address? AuAddress[]|Address[] - An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).
- multipleBirthBoolean? boolean - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- active? boolean - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- photo? Attachment[] - Image of the patient.
- birthDate date - The date of birth for the individual.
- 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.
- deceasedBoolean? boolean - Boolean indicator if the individual is deceased or not.
- managingOrganization? Reference - Organization that is the custodian of the patient record.
- 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.
- multipleBirthInteger? integer - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- name AUCorePatientName[] - A name associated with the individual.
- 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.
- maritalStatus? CodeableConcept - This field contains a patient's most recent marital (civil) status.
- Element... - Rest field
health.fhir.r4.aucore040: AUCorePatientCommunication
FHIR AUCorePatientCommunication datatype record.
Fields
- 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).
- language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- preferred? boolean - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
health.fhir.r4.aucore040: AUCorePatientContact
FHIR AUCorePatientContact datatype record.
Fields
- 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.
- period? Period - The period during which this contact person or organization is valid to be contacted relating to this patient.
- address? Address - An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
- gender? AUCorePatientContactGender - Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
- 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).
- organization? Reference - Organization on behalf of which the contact is acting or for which the contact is working.
- name? HumanName - A name associated with the contact person.
- telecom? ContactPoint[] - A contact detail for the person, e.g. a telephone number or an email address.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- relationship? CodeableConcept[] - The nature of the relationship between the patient and the contact person.
health.fhir.r4.aucore040: AUCorePatientIdentifierDva
FHIR AUCorePatientIdentifierDva datatype record.
health.fhir.r4.aucore040: AUCorePatientIdentifierIhi
FHIR AUCorePatientIdentifierIhi datatype record.
health.fhir.r4.aucore040: AUCorePatientIdentifierMedicare
FHIR AUCorePatientIdentifierMedicare datatype record.
health.fhir.r4.aucore040: AUCorePatientLink
FHIR AUCorePatientLink datatype record.
Fields
- 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.
- other Reference - The other patient resource that the link refers to.
- 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 AUCorePatientLinkType - The type of link between this patient resource and another patient resource.
health.fhir.r4.aucore040: AUCorePatientName
FHIR AUCorePatientName datatype record.
Fields
- given? string[] - Given name.
- 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.
- period? Period - Indicates the period of time when this name was valid for the named person.
- prefix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
- use? AUCorePatientNameUse - Identifies the purpose for this name.
- 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 - Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
- family? string - The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
- suffix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
health.fhir.r4.aucore040: AUCorePractitioner
FHIR AUCorePractitioner resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREPRACTITIONER(default RESOURCE_NAME_AUCOREPRACTITIONER) - The type of the resource describes
- identifier? Identifier[]|AuPbsprescribernumber[]|AuAhpraregistrationnumber[]|AuCareagencyemployeeidentifier[]|AuHpii[] - An identifier that applies to this person in this role.
- identifier Slicings
- AUCorePractitionerIdentifierHpii: Healthcare Provider Identifier – Individual (HPI-I)
- min = 0
- max = 1
- extension? Extension[] - An Extension
- extension Slicings
- Extension: Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
- min = 0
- max = *
- address? AuAddress[]|Address[] - An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
- gender? AUCorePractitionerGender - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- 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).
- active? boolean - Whether this practitioner's record is in active use.
- photo? Attachment[] - Image of the person.
- language? code - The base language in which the resource is written.
- birthDate? date - The date of birth for the practitioner.
- qualification? AUCorePractitionerQualification[] - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- 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.
- 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.
- name AUCorePractitionerName[] - The name(s) associated with the practitioner.
- 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.
- telecom? ContactPoint[] - A contact detail for the practitioner, e.g. a telephone number or an email address.
- 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.
- communication? CodeableConcept[] - A language the practitioner can use in patient communication.
- Element... - Rest field
health.fhir.r4.aucore040: AUCorePractitionerIdentifierHpii
FHIR AUCorePractitionerIdentifierHpii datatype record.
health.fhir.r4.aucore040: AUCorePractitionerName
FHIR AUCorePractitionerName datatype record.
Fields
- given? string[] - Given name.
- 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.
- period? Period - Indicates the period of time when this name was valid for the named person.
- prefix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
- use? AUCorePractitionerNameUse - Identifies the purpose for this name.
- 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 - Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
- family string - The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
- suffix? string[] - Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
health.fhir.r4.aucore040: AUCorePractitionerQualification
FHIR AUCorePractitionerQualification datatype record.
Fields
- identifier? Identifier[] - An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- extension? Extension[] - An Extension
- period? Period - Period during which the qualification is valid.
- code CodeableConcept - Coded representation of the qualification.
- 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.
- issuer? Reference - Organization that regulates and issues the qualification.
health.fhir.r4.aucore040: AUCorePractitionerRole
FHIR AUCorePractitionerRole resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREPRACTITIONERROLE(default RESOURCE_NAME_AUCOREPRACTITIONERROLE) - The type of the resource describes
- identifier? AuNationalprovideridentifieratorganisation[]|Identifier[]|AuEmployeenumber[]|AuMedicareprovidernumber[] - Business Identifiers that are specific to a role/location.
- identifier Slicings
- AUCorePractitionerRoleIdentifierMedicareProvider: Medicare Provider Number
- min = 0
- max = 1
- 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.
- period? Period - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
- specialty? CodeableConcept[] - Specific specialty of the practitioner.
- code? CodeableConcept[] - Roles which this practitioner is authorized to perform for the organization.
- practitioner Reference - Practitioner that is able to provide the defined services for the organization.
- 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).
- active? boolean - Whether this practitioner role record is in active use.
- language? code - The base language in which the resource is written.
- notAvailable? AUCorePractitionerRoleNotAvailable[] - The practitioner is not available or performing this role during this period of time due to the provided reason.
- availableTime? AUCorePractitionerRoleAvailableTime[] - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
- 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.
- endpoint? Reference[] - Technical endpoints providing access to services operated for the practitioner with this role.
- healthcareService? Reference[] - The list of healthcare services that this worker provides for this role's Organization/Location(s).
- 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.
- organization? Reference - The organization where the Practitioner performs the roles associated.
- 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.
- location? Reference[] - The location(s) at which this practitioner provides care.
- telecom? ContactPoint[] - Contact details that are specific to the role/location/service.
- 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.
- availabilityExceptions? string - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
- Element... - Rest field
health.fhir.r4.aucore040: AUCorePractitionerRoleAvailableTime
FHIR AUCorePractitionerRoleAvailableTime datatype record.
Fields
- allDay? boolean - Is this always available? (hence times are irrelevant) e.g. 24 hour service.
- 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).
- availableEndTime? time - The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- daysOfWeek? AUCorePractitionerRoleAvailableTimeDaysOfWeek[] - Indicates which days of the week are available between the start and end Times.
- availableStartTime? time - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
health.fhir.r4.aucore040: AUCorePractitionerRoleIdentifierMedicareProvider
FHIR AUCorePractitionerRoleIdentifierMedicareProvider datatype record.
health.fhir.r4.aucore040: AUCorePractitionerRoleNotAvailable
FHIR AUCorePractitionerRoleNotAvailable datatype record.
Fields
- 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).
- description string - The reason that can be presented to the user as to why this time is not available.
- during? Period - Service is not available (seasonally or for a public holiday) from this date.
- 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.aucore040: AUCoreProcedure
FHIR AUCoreProcedure resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREPROCEDURE(default RESOURCE_NAME_AUCOREPROCEDURE) - The type of the resource describes
- note? Annotation[] - Any other notes and comments about the procedure.
- partOf? Reference[] - A larger event of which this particular procedure is a component or step.
- complication? CodeableConcept[] - Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
- extension? Extension[] - An Extension
- extension Slicings
- Extension: The target point for this procedure
- min = 0
- max = *
- code CodeableConcept - The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy').
- subject Reference - The person, animal or group on which the procedure was performed.
- 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).
- reasonReference? Reference[] - The justification of why the procedure was performed.
- language? code - The base language in which the resource is written.
- performedRange? Range - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performedAge? Age - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- performedPeriod? Period - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performedString? string - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- followUp? CodeableConcept[] - If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
- statusReason? CodeableConcept - Captures the reason for the current state of the procedure.
- usedCode? CodeableConcept[] - Identifies coded items that were used as part of the procedure.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
- 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.
- performedDateTime? dateTime - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- basedOn? Reference[] - A reference to a resource that contains details of the request for this procedure.
- outcome? CodeableConcept - The outcome of the procedure - did it resolve the reasons for the procedure being performed?
- identifier? Identifier[] - Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
- recorder? Reference - Individual who recorded the record and takes responsibility for its content.
- complicationDetail? Reference[] - Any complications that occurred during the procedure, or in the immediate post-performance period.
- performer? AUCoreProcedurePerformer[] - Limited to 'real' people rather than equipment.
- usedReference? Reference[] - Identifies medications, devices and any other substance used as part of the procedure.
- focalDevice? AUCoreProcedureFocalDevice[] - A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
- encounter? Reference - The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
- instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- bodySite? CodeableConcept[] - Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
- 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 procedure statement.
- 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.
- report? Reference[] - This could be a histology result, pathology report, surgical report, etc.
- 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.
- location? Reference - The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
- category? CodeableConcept - A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure').
- status AUCoreProcedureStatus - A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreProcedureFocalDevice
FHIR AUCoreProcedureFocalDevice datatype record.
Fields
- 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).
- action? CodeableConcept - The kind of change that happened to the device during the procedure.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- manipulated Reference - The device that was manipulated (changed) during the procedure.
health.fhir.r4.aucore040: AUCoreProcedurePerformer
FHIR AUCoreProcedurePerformer datatype record.
Fields
- actor Reference - The practitioner who was involved in the procedure.
- 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.
- 'function? CodeableConcept - Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.
- 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).
- onBehalfOf? Reference - The organization the device or practitioner was acting on behalf of.
- 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.aucore040: AUCoreRespirationRate
FHIR AUCoreRespirationRate resource record.
Fields
- resourceType RESOURCE_NAME_AUCORERESPIRATIONRATE(default RESOURCE_NAME_AUCORERESPIRATIONRATE) - The type of the resource describes
- 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.
- code AUCoreRespirationRateCode - Respiratory Rate.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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? AUCoreRespirationRateValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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? AUCoreRespirationRateComponent[] - Used when reporting systolic and diastolic blood pressure.
- 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? AUCoreRespirationRateReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreRespirationRateCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreRespirationRateStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreRespirationRateCategoryCoding
FHIR AUCoreRespirationRateCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreRespirationRateCategoryVSCat
FHIR AUCoreRespirationRateCategoryVSCat datatype record.
Fields
- coding AUCoreRespirationRateCategoryCoding[] - 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.aucore040: AUCoreRespirationRateCode
FHIR AUCoreRespirationRateCode datatype record.
Fields
- 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.aucore040: AUCoreRespirationRateCodeCodingRespRateCode
FHIR AUCoreRespirationRateCodeCodingRespRateCode datatype record.
Fields
- 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 code(default "9279-1") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreRespirationRateCodeCodingSnomedRespRateCode
FHIR AUCoreRespirationRateCodeCodingSnomedRespRateCode datatype record.
Fields
- 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 code(default "86290005") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreRespirationRateComponent
FHIR AUCoreRespirationRateComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreRespirationRateReferenceRange
FHIR AUCoreRespirationRateReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreRespirationRateValue
FHIR AUCoreRespirationRateValue datatype record.
Fields
- comparator? AUCoreRespirationRateValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- 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.
- unit string - A human-readable form of the unit.
- code code(default "/min") - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
health.fhir.r4.aucore040: AUCoreSmokingStatus
FHIR AUCoreSmokingStatus resource record.
Fields
- resourceType RESOURCE_NAME_AUCORESMOKINGSTATUS(default RESOURCE_NAME_AUCORESMOKINGSTATUS) - The type of the resource describes
- 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.
- code AUCoreSmokingStatusCode - 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
focus
element or thecode
itself specifies the actual focus of the observation.
- 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.
- 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.
- 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.
- 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.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- 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? AUCoreSmokingStatusComponent[] - 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? AUCoreSmokingStatusReferenceRange[] - 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
referenceRange
elements would be used.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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.
- 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.
- category Slicings
- AUCoreSmokingStatusCategorySocialHistory: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreSmokingStatusStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreSmokingStatusCategoryCoding
FHIR AUCoreSmokingStatusCategoryCoding datatype record.
Fields
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "social-history") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.aucore040: AUCoreSmokingStatusCategorySocialHistory
FHIR AUCoreSmokingStatusCategorySocialHistory datatype record.
Fields
- coding AUCoreSmokingStatusCategoryCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.aucore040: AUCoreSmokingStatusCode
FHIR AUCoreSmokingStatusCode datatype record.
Fields
- coding AUCoreSmokingStatusCodeCoding[] - 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.aucore040: AUCoreSmokingStatusCodeCoding
FHIR AUCoreSmokingStatusCodeCoding datatype record.
Fields
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "1747861000168109") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
health.fhir.r4.aucore040: AUCoreSmokingStatusCodeCodingLoincSmokingStatus
FHIR AUCoreSmokingStatusCodeCodingLoincSmokingStatus datatype record.
Fields
- 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 code(default "72166-2") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreSmokingStatusComponent
FHIR AUCoreSmokingStatusComponent datatype record.
Fields
- 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.
- 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.aucore040: AUCoreSmokingStatusReferenceRange
FHIR AUCoreSmokingStatusReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreWaistCircumference
FHIR AUCoreWaistCircumference resource record.
Fields
- resourceType RESOURCE_NAME_AUCOREWAISTCIRCUMFERENCE(default RESOURCE_NAME_AUCOREWAISTCIRCUMFERENCE) - The type of the resource describes
- valueBoolean? boolean - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- 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 - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- code AUCoreWaistCircumferenceCode - Coded Responses from C-CDA Vital Sign Results.
- 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
focus
element or thecode
itself specifies the actual focus of the observation.
- valueRange? Range - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- 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 - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- valueRatio? Ratio - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- 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 - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- 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 - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- 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? AUCoreWaistCircumferenceValue - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - Used when reporting vital signs panel components.
- 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? AUCoreWaistCircumferenceComponent[] - Used when reporting systolic and diastolic blood pressure.
- 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? AUCoreWaistCircumferenceReferenceRange[] - 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
referenceRange
elements would be used.
- valueString? string - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- effectiveDateTime dateTime - Date, and optionally time, the observation was performed.
- 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 - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- valuePeriod? Period - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- 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.
- category Slicings
- AUCoreWaistCircumferenceCategoryVSCat: Classification of type of observation
- min = 1
- max = 1
- device? Reference - The device used to generate the observation data.
- status AUCoreWaistCircumferenceStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aucore040: AUCoreWaistCircumferenceCategoryCoding
FHIR AUCoreWaistCircumferenceCategoryCoding datatype record.
Fields
- 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 code(default "vital-signs") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/observation-category") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreWaistCircumferenceCategoryVSCat
FHIR AUCoreWaistCircumferenceCategoryVSCat datatype record.
Fields
- coding AUCoreWaistCircumferenceCategoryCoding[] - 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.aucore040: AUCoreWaistCircumferenceCode
FHIR AUCoreWaistCircumferenceCode datatype record.
Fields
- 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.aucore040: AUCoreWaistCircumferenceCodeCodingLoincWaistCircumCode
FHIR AUCoreWaistCircumferenceCodeCodingLoincWaistCircumCode datatype record.
Fields
- 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 code(default "8280-0") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreWaistCircumferenceCodeCodingSnomedWaistCircumCode
FHIR AUCoreWaistCircumferenceCodeCodingSnomedWaistCircumCode datatype record.
Fields
- 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 code(default "276361009") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.aucore040: AUCoreWaistCircumferenceComponent
FHIR AUCoreWaistCircumferenceComponent datatype record.
Fields
- valueBoolean? boolean - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueRatio? Ratio - Vital Sign Value recorded with UCUM.
- valueString? string - Vital Sign Value recorded with UCUM.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - Vital Sign Value recorded with UCUM.
- valuePeriod? Period - Vital Sign Value recorded with UCUM.
- valueDateTime? dateTime - Vital Sign Value recorded with UCUM.
- 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 - Vital Sign Value recorded with UCUM.
- valueQuantity? Quantity - Vital Sign Value recorded with UCUM.
health.fhir.r4.aucore040: AUCoreWaistCircumferenceReferenceRange
FHIR AUCoreWaistCircumferenceReferenceRange datatype record.
Fields
- 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
appliesTo
are 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.aucore040: AUCoreWaistCircumferenceValue
FHIR AUCoreWaistCircumferenceValue datatype record.
Fields
- comparator? AUCoreWaistCircumferenceValueComparator - How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is '<' , then the real value is < stated value.
- 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.
- unit string - A human-readable form of the unit.
- code code - Coded responses from the common UCUM units for vital signs value set.
- system uri(default "http://unitsofmeasure.org") - The identification of the system that provides the coded form of the unit.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- value decimal - The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Import
import ballerinax/health.fhir.r4.aucore040;
Metadata
Released date: 7 days ago
Version: 2.0.0
Compatibility
Platform: any
Ballerina version: 2201.12.2
GraalVM compatible: Yes
Pull count
Total: 180
Current verison: 0
Weekly downloads
Keywords
Healthcare
FHIR
R4
aucore040
Contributors
Other versions
2.0.0
1.0.0Dependencies