health.fhir.r4.aubase410
Module health.fhir.r4.aubase410
API
Declarations
Definitions
ballerinax/health.fhir.r4.aubase410 Ballerina library
FHIR R4 AUBase module
Sample Usage
This section focuses on samples depicting how to use this package to implement FHIR related integrations
Prerequisites
- Install Ballerina 2201.6.0 or later
1. Parse JSON FHIR resource to FHIR resource model
Sample below is using the AUBasePatient resource in health.fhir.r4.aubase410
package.
import ballerina/log; import ballerinax/health.fhir.r4.aubase410; import ballerinax/health.fhir.r4.parser; public function main() { json patientPayload = { "resourceType": "Patient", "id": "1", "meta": { "profile": [ "http://hl7.org.au/fhir/StructureDefinition/au-patient" ] }, "active":true, "name": [ { "use":"official", "family":"Chalmers", "given":[ "Peter", "James" ] } ], "gender":"male", "birthDate": { "value" : "1974-12-25" }, "managingOrganization": { "reference":"Organization/1" } }; do { anydata parsedResult = check parser:parse(patientPayload, aubase410:AUBasePatient); aubase410:AUBasePatient patientModel = check parsedResult.ensureType(); log:printInfo(string `Patient name : ${patientModel.name.toString()}`); } on fail error parseError { log:printError(string `Error occurred while parsing : ${parseError.message()}`, parseError); } }
2. Creating FHIR Resource models and serializing to JSON wire formats
import ballerina/log; import ballerina/time; import ballerinax/health.fhir.r4; import ballerinax/health.fhir.r4.aubase410; public function main() { aubase410:AUBasePatient patient = { meta: { lastUpdated: time:utcToString(time:utcNow()), profile: [aubase410:PROFILE_BASE_AUBASEPATIENT] }, active: true, name: [{ family: "Doe", given: ["Jhon"], use: r4:official, prefix: ["Mr"] }], address: [{ line: ["652 S. Lantern Dr."], city: "New York", country: "United States", postalCode: "10022", 'type: r4:physical, use: r4:home }] }; r4:FHIRResourceEntity fhirEntity = new(patient); // Serialize FHIR resource record to Json payload json|r4:FHIRSerializerError jsonResult = fhirEntity.toJson(); if jsonResult is json { log:printInfo(string `Patient resource JSON payload : ${jsonResult.toJsonString()}`); } else { log:printError(string `Error occurred while serializing to JSON payload : ${jsonResult.message()}`, jsonResult); } }
Functions
initialize
function initialize()
This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.aubase410: PROFILE_BASE_AUASSERTIONNORELEVANTFINDING
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEALLERGYINTOLERANCE
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEBODYSTRUCTURE
health.fhir.r4.aubase410: PROFILE_BASE_AUBASECOMPOSITION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASECONDITION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEDIAGNOSTICIMAGINGREPORT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEDIAGNOSTICIMAGINGRESULT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEDIAGNOSTICREPORT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEDIAGNOSTICREQUEST
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEDIAGNOSTICRESULT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEENCOUNTER
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEHEALTHCARESERVICE
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEIMMUNISATION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASELOCATION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEMEDICATION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEMEDICATIONADMINISTRATION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEMEDICATIONDISPENSE
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEMEDICATIONREQUEST
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEMEDICATIONSTATEMENT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEORGANISATION
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEPATHOLOGYREPORT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEPATHOLOGYRESULT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEPATIENT
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEPRACTITIONER
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEPRACTITIONERROLE
health.fhir.r4.aubase410: PROFILE_BASE_AUBASEPROCEDURE
health.fhir.r4.aubase410: PROFILE_BASE_AUBASERELATEDPERSON
health.fhir.r4.aubase410: PROFILE_BASE_AUBASESPECIMEN
health.fhir.r4.aubase410: PROFILE_BASE_AUBASESUBSTANCE
health.fhir.r4.aubase410: PROFILE_BASE_AUHEALTHPROGRAMPARTICIPATIONSUMMARY
health.fhir.r4.aubase410: PROFILE_BASE_AUMEDICINELIST
health.fhir.r4.aubase410: RESOURCE_NAME_AUASSERTIONNORELEVANTFINDING
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEALLERGYINTOLERANCE
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEBODYSTRUCTURE
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASECOMPOSITION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASECONDITION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEDIAGNOSTICIMAGINGREPORT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEDIAGNOSTICIMAGINGRESULT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEDIAGNOSTICREPORT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEDIAGNOSTICREQUEST
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEDIAGNOSTICRESULT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEENCOUNTER
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEHEALTHCARESERVICE
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEIMMUNISATION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASELOCATION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEMEDICATION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEMEDICATIONADMINISTRATION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEMEDICATIONDISPENSE
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEMEDICATIONREQUEST
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEMEDICATIONSTATEMENT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEORGANISATION
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEPATHOLOGYREPORT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEPATHOLOGYRESULT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEPATIENT
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEPRACTITIONER
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEPRACTITIONERROLE
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASEPROCEDURE
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASERELATEDPERSON
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASESPECIMEN
health.fhir.r4.aubase410: RESOURCE_NAME_AUBASESUBSTANCE
health.fhir.r4.aubase410: RESOURCE_NAME_AUHEALTHPROGRAMPARTICIPATIONSUMMARY
health.fhir.r4.aubase410: RESOURCE_NAME_AUMEDICINELIST
Enums
health.fhir.r4.aubase410: AuAccessionnumberUse
Members
health.fhir.r4.aubase410: AuAddressType
Members
health.fhir.r4.aubase410: AuAddressUse
Members
health.fhir.r4.aubase410: AuAhpraregistrationnumberUse
Members
health.fhir.r4.aubase410: AUAssertionNoRelevantFindingStatus
AUAssertionNoRelevantFindingStatus enum
Members
health.fhir.r4.aubase410: AuAustralianbusinessnumberUse
Members
health.fhir.r4.aubase410: AuAustraliancompanynumberUse
Members
health.fhir.r4.aubase410: AuAustralianregistredbodynumberUse
Members
health.fhir.r4.aubase410: AUBaseAllergyIntoleranceCategory
AUBaseAllergyIntoleranceCategory enum
Members
health.fhir.r4.aubase410: AUBaseAllergyIntoleranceCriticality
AUBaseAllergyIntoleranceCriticality enum
Members
health.fhir.r4.aubase410: AUBaseAllergyIntoleranceReactionSeverity
AUBaseAllergyIntoleranceReactionSeverity enum
Members
health.fhir.r4.aubase410: AUBaseAllergyIntoleranceType
AUBaseAllergyIntoleranceType enum
Members
health.fhir.r4.aubase410: AUBaseCompositionAttesterMode
AUBaseCompositionAttesterMode enum
Members
health.fhir.r4.aubase410: AUBaseCompositionRelatesToCode
AUBaseCompositionRelatesToCode enum
Members
health.fhir.r4.aubase410: AUBaseCompositionSectionMode
AUBaseCompositionSectionMode enum
Members
health.fhir.r4.aubase410: AUBaseCompositionStatus
AUBaseCompositionStatus enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticImagingReportStatus
AUBaseDiagnosticImagingReportStatus enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticImagingResultStatus
AUBaseDiagnosticImagingResultStatus enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticReportStatus
AUBaseDiagnosticReportStatus enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticRequestIntent
AUBaseDiagnosticRequestIntent enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticRequestPriority
AUBaseDiagnosticRequestPriority enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticRequestStatus
AUBaseDiagnosticRequestStatus enum
Members
health.fhir.r4.aubase410: AUBaseDiagnosticResultStatus
AUBaseDiagnosticResultStatus enum
Members
health.fhir.r4.aubase410: AUBaseEncounterLocationStatus
AUBaseEncounterLocationStatus enum
Members
health.fhir.r4.aubase410: AUBaseEncounterStatus
AUBaseEncounterStatus enum
Members
health.fhir.r4.aubase410: AUBaseEncounterStatusHistoryStatus
AUBaseEncounterStatusHistoryStatus enum
Members
health.fhir.r4.aubase410: AUBaseHealthcareServiceAvailableTimeDaysOfWeek
AUBaseHealthcareServiceAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.aubase410: AUBaseImmunisationStatus
AUBaseImmunisationStatus enum
Members
health.fhir.r4.aubase410: AUBaseLocationHoursOfOperationDaysOfWeek
AUBaseLocationHoursOfOperationDaysOfWeek enum
Members
health.fhir.r4.aubase410: AUBaseLocationMode
AUBaseLocationMode enum
Members
health.fhir.r4.aubase410: AUBaseLocationStatus
AUBaseLocationStatus enum
Members
health.fhir.r4.aubase410: AUBaseMedicationAdministrationStatus
AUBaseMedicationAdministrationStatus enum
Members
health.fhir.r4.aubase410: AUBaseMedicationDispenseStatus
AUBaseMedicationDispenseStatus enum
Members
health.fhir.r4.aubase410: AUBaseMedicationRequestIntent
AUBaseMedicationRequestIntent enum
Members
health.fhir.r4.aubase410: AUBaseMedicationRequestPriority
AUBaseMedicationRequestPriority enum
Members
health.fhir.r4.aubase410: AUBaseMedicationRequestStatus
AUBaseMedicationRequestStatus enum
Members
health.fhir.r4.aubase410: AUBaseMedicationStatementStatus
AUBaseMedicationStatementStatus enum
Members
health.fhir.r4.aubase410: AUBaseMedicationStatus
AUBaseMedicationStatus enum
Members
health.fhir.r4.aubase410: AUBasePathologyReportStatus
AUBasePathologyReportStatus enum
Members
health.fhir.r4.aubase410: AUBasePathologyResultStatus
AUBasePathologyResultStatus enum
Members
health.fhir.r4.aubase410: AUBasePatientContactGender
AUBasePatientContactGender enum
Members
health.fhir.r4.aubase410: AUBasePatientGender
AUBasePatientGender enum
Members
health.fhir.r4.aubase410: AUBasePatientLinkType
AUBasePatientLinkType enum
Members
health.fhir.r4.aubase410: AUBasePractitionerGender
AUBasePractitionerGender enum
Members
health.fhir.r4.aubase410: AUBasePractitionerRoleAvailableTimeDaysOfWeek
AUBasePractitionerRoleAvailableTimeDaysOfWeek enum
Members
health.fhir.r4.aubase410: AUBaseProcedureStatus
AUBaseProcedureStatus enum
Members
health.fhir.r4.aubase410: AUBaseRelatedPersonGender
AUBaseRelatedPersonGender enum
Members
health.fhir.r4.aubase410: AUBaseSpecimenStatus
AUBaseSpecimenStatus enum
Members
health.fhir.r4.aubase410: AUBaseSubstanceStatus
AUBaseSubstanceStatus enum
Members
health.fhir.r4.aubase410: AuCareagencyemployeeidentifierUse
Members
health.fhir.r4.aubase410: AuCspregistrationnumberUse
Members
health.fhir.r4.aubase410: AuCwlthseniorshealthcardnumberUse
Members
health.fhir.r4.aubase410: AuDeliverypointidentifierUse
Members
health.fhir.r4.aubase410: AuDvanumberUse
Members
health.fhir.r4.aubase410: AuEmployeenumberUse
Members
health.fhir.r4.aubase410: AuEtpprescriptionidentifierUse
Members
health.fhir.r4.aubase410: AuGnafidentifierUse
Members
health.fhir.r4.aubase410: AuHealthcarecardnumberUse
Members
health.fhir.r4.aubase410: AUHealthProgramParticipationSummaryStatus
AUHealthProgramParticipationSummaryStatus enum
Members
health.fhir.r4.aubase410: AuHpiiUse
Members
health.fhir.r4.aubase410: AuHpioUse
Members
health.fhir.r4.aubase410: AuIhiUse
Members
health.fhir.r4.aubase410: AuInsurancemembernumberUse
Members
health.fhir.r4.aubase410: AuLocaldispenseidentifierUse
Members
health.fhir.r4.aubase410: AuLocalorderidentifierUse
Members
health.fhir.r4.aubase410: AuLocalprescriptionidentifierUse
Members
health.fhir.r4.aubase410: AuLocalreportidentifierUse
Members
health.fhir.r4.aubase410: AuLocationspecificpracticenumberUse
Members
health.fhir.r4.aubase410: AuMedicalrecordnumberUse
Members
health.fhir.r4.aubase410: AuMedicarecardnumberUse
Members
health.fhir.r4.aubase410: AuMedicareprovidernumberUse
Members
health.fhir.r4.aubase410: AUMedicineListMode
AUMedicineListMode enum
Members
health.fhir.r4.aubase410: AUMedicineListStatus
AUMedicineListStatus enum
Members
health.fhir.r4.aubase410: AuNataaccreditationnumberUse
Members
health.fhir.r4.aubase410: AuNatasitenumberUse
Members
health.fhir.r4.aubase410: AuNationalprovideridentifieratorganisationUse
Members
health.fhir.r4.aubase410: AuPaididentifierUse
Members
health.fhir.r4.aubase410: AuPaioidentifierUse
Members
health.fhir.r4.aubase410: AuPbsprescribernumberUse
Members
health.fhir.r4.aubase410: AuPensionerconcessioncardnumberUse
Members
health.fhir.r4.aubase410: AuPharmacyapprovalnumberUse
Members
health.fhir.r4.aubase410: AuResidentialagedcareserviceidentifierUse
Members
Variables
health.fhir.r4.aubase410: terminologyProcessor
Terminology processor instance
health.fhir.r4.aubase410: fhirRegistry
FHIR registry instance
health.fhir.r4.aubase410: FHIR_VALUE_SETS
health.fhir.r4.aubase410: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.aubase410: AddressIdentifier
Fields
- Fields Included from *IdentifierExtension
- url uri
- valueIdentifier Identifier
- id string? -
- extension Extension[]? -
- valueIdentifier Identifier -
- url string -
health.fhir.r4.aubase410: AhpraprofessionDetails
Fields
- Fields Included from *Base64BinaryExtension
- url uri
- valueBase64Binary base64Binary
- id string? -
- extension Extension[]? -
- valueCodeableConcept CodeableConcept? -
- valueString string? -
- valueDate date? -
- url string -
health.fhir.r4.aubase410: AhpraregistrationDetails
Fields
- Fields Included from *Base64BinaryExtension
- url uri
- valueBase64Binary base64Binary
- id string? -
- extension Extension[]? -
- valueCodeableConcept CodeableConcept? -
- valueString string? -
- valueDate date? -
- url string -
health.fhir.r4.aubase410: AssociatedHealthcareservice
Fields
- Fields Included from *ReferenceExtension
- id string? -
- extension Extension[]? -
- valueReference Reference -
- url string -
health.fhir.r4.aubase410: AuAccessionnumber
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element...
- id string? -
- extension Extension[]? -
- reference string? -
- identifier Identifier? -
- period Period? -
- system uri -
- display string -
- assigner Reference -
- AuAccessionnumberUse AuAccessionnumberUse? -
- 'type CodeableConcept -
- value string -
health.fhir.r4.aubase410: AuAddress
Fields
- Fields Included from *Address
- id string? -
- extension Extension[]? -
- country string? -
- valueIdentifier Identifier -
- period Period? -
- city string? -
- AuAddressUse AuAddressUse? -
- line string[]? -
- district string? -
- postalCode string? -
- text string? -
- state string? -
- AuAddressType AuAddressType? -
- url string -
health.fhir.r4.aubase410: AuAhpraregistrationnumber
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element...
- id string? -
- extension Extension[]? -
- period Period? -
- system uri -
- assigner Reference? -
- AuAhpraregistrationnumberUse AuAhpraregistrationnumberUse? -
- 'type CodeableConcept -
- value string -
health.fhir.r4.aubase410: AUAssertionNoRelevantFinding
FHIR AUAssertionNoRelevantFinding resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUASSERTIONNORELEVANTFINDING(default RESOURCE_NAME_AUASSERTIONNORELEVANTFINDING) - 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 AUAssertionNoRelevantFindingCode - 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 - An assertion that a procedure did not occur or that there are no items of specific interest (e.g. allergies, no current medications) for a patient or patient group.
- 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'.
- effectivePeriod Period? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- effectiveTiming Timing? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method CodeableConcept? - Indicates the mechanism used to perform the observation.
- hasMember Reference[]? - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component AUAssertionNoRelevantFindingComponent[]? - 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 AUAssertionNoRelevantFindingReferenceRange[]? - 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? - 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.
- 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 AUAssertionNoRelevantFindingStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aubase410: AUAssertionNoRelevantFindingCode
FHIR AUAssertionNoRelevantFindingCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding AUAssertionNoRelevantFindingCodeCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.aubase410: AUAssertionNoRelevantFindingCodeCoding
FHIR AUAssertionNoRelevantFindingCodeCoding datatype record.
Fields
- Fields Included from *Coding
- system uri(default "http://terminology.hl7.org/CodeSystem/v3-ActCode") - The identification of the code system that defines the meaning of the symbol in the code.
- code code(default "ASSERTION") - 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.aubase410: AUAssertionNoRelevantFindingComponent
FHIR AUAssertionNoRelevantFindingComponent datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.
- 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.aubase410: AUAssertionNoRelevantFindingReferenceRange
FHIR AUAssertionNoRelevantFindingReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- high Quantity? - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
- low Quantity? - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple
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.aubase410: AuAssigningauthority
Fields
- Fields Included from *Base64BinaryExtension
- url uri
- valueBase64Binary base64Binary
- id string? -
- extension Extension[]? -
- valueString string? -
- url uri -
health.fhir.r4.aubase410: AuAustralianbusinessnumber
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element...
- id string? -
- extension Extension[]? -
- period Period? -
- system uri -
- AuAustralianbusinessnumberUse AuAustralianbusinessnumberUse? -
- assigner Reference? -
- 'type CodeableConcept -
- value string -
health.fhir.r4.aubase410: AuAustraliancompanynumber
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element...
- id string? -
- extension Extension[]? -
- period Period? -
- system uri -
- assigner Reference? -
- 'type CodeableConcept -
- value string -
- AuAustraliancompanynumberUse AuAustraliancompanynumberUse? -
health.fhir.r4.aubase410: AuAustralianregistredbodynumber
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element...
- id string? -
- extension Extension[]? -
- period Period? -
- system uri -
- AuAustralianregistredbodynumberUse AuAustralianregistredbodynumberUse? -
- assigner Reference? -
- 'type CodeableConcept -
- value string -
health.fhir.r4.aubase410: AUBaseAllergyIntolerance
FHIR AUBaseAllergyIntolerance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEALLERGYINTOLERANCE(default RESOURCE_NAME_AUBASEALLERGYINTOLERANCE) - 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 AUBaseAllergyIntoleranceCriticality? - 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 AUBaseAllergyIntoleranceType? - Identification of the underlying physiological mechanism for the reaction risk.
- onsetString string? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- onsetAge Age? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- lastOccurrence dateTime? - Represents the date and/or time of the last known occurrence of a reaction event.
- patient Reference - The patient who has the allergy or intolerance.
- 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 AUBaseAllergyIntoleranceReaction[]? - 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 AUBaseAllergyIntoleranceCategory[]? - Category of the identified substance.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseAllergyIntoleranceReaction
FHIR AUBaseAllergyIntoleranceReaction datatype record.
Fields
- Fields Included from *BackboneElement
- severity AUBaseAllergyIntoleranceReactionSeverity? - 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.aubase410: AUBaseBodyStructure
FHIR AUBaseBodyStructure resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEBODYSTRUCTURE(default RESOURCE_NAME_AUBASEBODYSTRUCTURE) - The type of the resource describes
- identifier Identifier[]? - Identifier for this instance of the anatomical structure.
- image Attachment[]? - Image or images used to identify a location.
- 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.
- morphology CodeableConcept? - The kind of structure being represented by the body structure at
BodyStructure.location
. This can define both normal and abnormal morphologies.
- locationQualifier CodeableConcept[]? - Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
- 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 body site is in active use.
- description string? - A summary, characterization or explanation of the body structure.
- language code? - The base language in which the resource is written.
- 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.
- patient Reference - The person to which the body site belongs.
- 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 CodeableConcept? - The anatomical location or region of the specimen, lesion, or body structure.
- 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.aubase410: AUBaseComposition
FHIR AUBaseComposition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASECOMPOSITION(default RESOURCE_NAME_AUBASECOMPOSITION) - The type of the resource describes
- date dateTime - The composition editing time, when the composition was last logically changed by the author.
- identifier Identifier? - A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
- extension Extension[]? - An Extension
- extension Slicings
- Extension: Who and/or what should receive a copy of the composition
- min = 0
- max = *
- custodian Reference? - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
- author Reference[] - Identifies who is responsible for the information in the composition, not necessarily who typed it in.
- subject Reference? - Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
- confidentiality code? - The code specifying the level of confidentiality of the Composition.
- 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.
- section AUBaseCompositionSection[]? - The root of the sections that make up the composition.
- encounter Reference? - Describes the clinical encounter or type of care this documentation is associated with.
- title string - Official human-readable label for the composition.
- 'type CodeableConcept - Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
- attester AUBaseCompositionAttester[]? - A participant who has attested to the accuracy of the composition/document.
- 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.
- 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.
- category CodeableConcept[]? - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
- event AUBaseCompositionEvent[]? - The clinical service, such as a colonoscopy or an appendectomy, being documented.
- relatesTo AUBaseCompositionRelatesTo[]? - Relationships that this composition has with other compositions or documents that already exist.
- status AUBaseCompositionStatus - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseCompositionAttester
FHIR AUBaseCompositionAttester datatype record.
Fields
- Fields Included from *BackboneElement
- mode AUBaseCompositionAttesterMode - The type of attestation the authenticator offers.
- 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.
- time dateTime? - When the composition was attested by the party.
- party Reference? - Who attested the composition in the specified way.
health.fhir.r4.aubase410: AUBaseCompositionEvent
FHIR AUBaseCompositionEvent datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- period Period? - The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
- code CodeableConcept[]? - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.
- 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[]? - The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
- 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.aubase410: AUBaseCompositionRelatesTo
FHIR AUBaseCompositionRelatesTo datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- targetIdentifier Identifier - The target composition/document of this relationship.
- code AUBaseCompositionRelatesToCode - The type of relationship that this composition has with anther composition or document.
- 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.
- targetReference Reference - The target composition/document of this relationship.
health.fhir.r4.aubase410: AUBaseCompositionSection
FHIR AUBaseCompositionSection datatype record.
Fields
- Fields Included from *BackboneElement
- mode AUBaseCompositionSectionMode? - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- entry Reference[]? - A reference to the actual resource from which the narrative in the section is derived.
- 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 code identifying the kind of content contained within the section. This must be consistent with the section title.
- emptyReason CodeableConcept? - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
- orderedBy CodeableConcept? - Specifies the order applied to the items in the section entries.
- author Reference[]? - Identifies who is responsible for the information in this section, not necessarily who typed it in.
- 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).
- focus Reference? - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
- 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 Narrative? - A human-readable narrative that contains the attested content of the section, 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.
- title string? - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
health.fhir.r4.aubase410: AUBaseCondition
FHIR AUBaseCondition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASECONDITION(default RESOURCE_NAME_AUBASECONDITION) - 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 AUBaseConditionEvidence[]? - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
- onsetRange Range? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- abatementDateTime dateTime? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- subject Reference - Indicates the patient or group who the condition record is associated with.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language code? - The base language in which the resource is written.
- clinicalStatus CodeableConcept? - The clinical status of the condition.
- onsetDateTime dateTime? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- onsetString string? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- onsetAge Age? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- abatementPeriod Period? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- abatementString string? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- severity CodeableConcept? - A subjective assessment of the severity of the condition as evaluated by the clinician.
- identifier Identifier[]? - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- recorder Reference? - Individual who recorded the record and takes responsibility for its content.
- onsetPeriod Period? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- verificationStatus CodeableConcept? - The verification status to support the clinical status of the condition.
- recordedDate dateTime? - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
- abatementRange Range? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.
- encounter Reference? - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
- bodySite 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 AUBaseConditionStage[]? - 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.aubase410: AUBaseConditionEvidence
FHIR AUBaseConditionEvidence datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept[]? - A manifestation or symptom that led to the recording of this condition.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- detail Reference[]? - Links to other relevant information, including pathology reports.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.aubase410: AUBaseConditionStage
FHIR AUBaseConditionStage datatype record.
Fields
- Fields Included from *BackboneElement
- summary CodeableConcept? - A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific.
- assessment Reference[]? - Reference to a formal record of the evidence on which the staging assessment is based.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type CodeableConcept? - The kind of staging, such as pathological or clinical staging.
health.fhir.r4.aubase410: AUBaseDiagnosticImagingReport
FHIR AUBaseDiagnosticImagingReport resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEDIAGNOSTICIMAGINGREPORT(default RESOURCE_NAME_AUBASEDIAGNOSTICIMAGINGREPORT) - The type of the resource describes
- 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 - A code or name that describes this diagnostic report.
- subject Reference - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
- 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).
- presentedForm Attachment[]? - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
- language code? - The base language in which the resource is written.
- media AUBaseDiagnosticImagingReportMedia[]? - A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
- conclusion string? - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
- result Reference[]? - Observations that are part of this diagnostic report.
- specimen Reference[]? - Details about the specimens on which this diagnostic report is based.
- 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 that this version of the report was made available to providers, typically after the report was reviewed and verified.
- basedOn Reference[]? - Details concerning a service requested.
- identifier Identifier[]|AuLocalreportidentifier[]|AuLocalorderidentifier[]|AuAccessionnumber[]? - Identifiers assigned to this report by the performer or other systems.
- performer Reference[]? - The diagnostic service that is responsible for issuing the report.
- effectivePeriod Period - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- resultsInterpreter Reference[]? - The practitioner or organization that is responsible for the report's conclusions and interpretations.
- conclusionCode CodeableConcept[]? - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
- 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.
- effectiveDateTime dateTime - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- 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 AUBaseDiagnosticImagingReportCategory[] - A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
- imagingStudy Reference[]? - One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
- status AUBaseDiagnosticImagingReportStatus - The status of the diagnostic report.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseDiagnosticImagingReportCategory
FHIR AUBaseDiagnosticImagingReportCategory datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[]? - A reference to a code defined by a terminology system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.aubase410: AUBaseDiagnosticImagingReportCategoryCodingAnatomicRegionOfInterest
FHIR AUBaseDiagnosticImagingReportCategoryCodingAnatomicRegionOfInterest datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseDiagnosticImagingReportMedia
FHIR AUBaseDiagnosticImagingReportMedia datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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).
- link Reference - Reference to the image source.
- comment string? - A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.
- 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.aubase410: AUBaseDiagnosticImagingResult
FHIR AUBaseDiagnosticImagingResult resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEDIAGNOSTICIMAGINGRESULT(default RESOURCE_NAME_AUBASEDIAGNOSTICIMAGINGRESULT) - 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[]? - An Extension
- extension Slicings
- Extension: Target anatomic location or structure
- min = 0
- max = 1
- 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.
- 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.
- component AUBaseDiagnosticImagingResultComponent[]? - 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 AUBaseDiagnosticImagingResultReferenceRange[]? - 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
- AUBaseDiagnosticImagingResultCategoryAnatomicRegionOfInterest: Anatomic Region Of Interest
- min = 0
- max = *
- AUBaseDiagnosticImagingResultCategoryDiagImg: Observation generated by imaging
- min = 1
- max = 1
- device Reference? - The device used to generate the observation data.
- status AUBaseDiagnosticImagingResultStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseDiagnosticImagingResultCategoryAnatomicRegionOfInterest
FHIR AUBaseDiagnosticImagingResultCategoryAnatomicRegionOfInterest datatype record.
Fields
- Fields Included from *CodeableConcept
- coding AUBaseDiagnosticImagingResultCategoryCoding[]? - 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.aubase410: AUBaseDiagnosticImagingResultCategoryCoding
FHIR AUBaseDiagnosticImagingResultCategoryCoding datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseDiagnosticImagingResultCategoryCodingOne
FHIR AUBaseDiagnosticImagingResultCategoryCodingOne datatype record.
Fields
- Fields Included from *Coding
- 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 "imaging") - 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.aubase410: AUBaseDiagnosticImagingResultCategoryDiagImg
FHIR AUBaseDiagnosticImagingResultCategoryDiagImg datatype record.
Fields
- Fields Included from *CodeableConcept
- coding AUBaseDiagnosticImagingResultCategoryCodingOne[] - 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.aubase410: AUBaseDiagnosticImagingResultComponent
FHIR AUBaseDiagnosticImagingResultComponent datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.
- 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.aubase410: AUBaseDiagnosticImagingResultReferenceRange
FHIR AUBaseDiagnosticImagingResultReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- high Quantity? - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
- low Quantity? - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple
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.aubase410: AUBaseDiagnosticReport
FHIR AUBaseDiagnosticReport resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEDIAGNOSTICREPORT(default RESOURCE_NAME_AUBASEDIAGNOSTICREPORT) - The type of the resource describes
- 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 - A code or name that describes this diagnostic report.
- subject Reference? - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
- 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).
- presentedForm Attachment[]? - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
- language code? - The base language in which the resource is written.
- media AUBaseDiagnosticReportMedia[]? - A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
- conclusion string? - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
- result Reference[]? - Observations that are part of this diagnostic report.
- specimen Reference[]? - Details about the specimens on which this diagnostic report is based.
- 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 that this version of the report was made available to providers, typically after the report was reviewed and verified.
- basedOn Reference[]? - Details concerning a service requested.
- identifier Identifier[]|AuLocalreportidentifier[]|AuLocalorderidentifier[]|AuAccessionnumber[]? - Identifiers assigned to this report by the performer or other systems.
- performer Reference[]? - The diagnostic service that is responsible for issuing the report.
- effectivePeriod Period? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- resultsInterpreter Reference[]? - The practitioner or organization that is responsible for the report's conclusions and interpretations.
- conclusionCode CodeableConcept[]? - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
- encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
- 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.
- effectiveDateTime dateTime? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- 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 clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
- imagingStudy Reference[]? - One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
- status AUBaseDiagnosticReportStatus - The status of the diagnostic report.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseDiagnosticReportMedia
FHIR AUBaseDiagnosticReportMedia datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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).
- link Reference - Reference to the image source.
- comment string? - A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.
- 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.aubase410: AUBaseDiagnosticRequest
FHIR AUBaseDiagnosticRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEDIAGNOSTICREQUEST(default RESOURCE_NAME_AUBASEDIAGNOSTICREQUEST) - The type of the resource describes
- insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
- note Annotation[]? - Any other notes and comments made about the service request. For example, internal billing notes.
- extension Extension[]? - An Extension
- extension Slicings
- Extension: The target point for this procedure
- min = 0
- max = *
- code CodeableConcept? - A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
- requisition Identifier? - A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
- subject Reference - On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
- 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[]? - Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in
supportingInfo
.
- 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 ServiceRequest.
- relevantHistory Reference[]? - Key events in the history of the request.
- supportingInfo Reference[]? - Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as 'ask at order entry questions (AOEs)'. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
- specimen Reference[]? - One or more specimens that the laboratory procedure will use.
- quantityQuantity Quantity? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- quantityRatio Ratio? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- asNeededBoolean boolean? - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- locationReference Reference[]? - A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
- reasonCode CodeableConcept[]? - An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in
supportingInfo
.
- 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? - Set this to true if the record is saying that the service/procedure should NOT be performed.
- basedOn Reference[]? - Plan/proposal/order fulfilled by this request.
- asNeededCodeableConcept CodeableConcept? - If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example 'pain', 'on flare-up', etc.
- requester Reference? - The individual who initiated the request and has responsibility for its activation.
- identifier Identifier[]|AuLocalorderidentifier[]? - Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
- authoredOn dateTime? - When the request transitioned to being actionable.
- performer Reference[]? - The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
- replaces Reference[]? - The request takes the place of the referenced completed or terminated request(s).
- encounter Reference? - An encounter that provides additional information about the healthcare context in which this request is made.
- occurrenceTiming Timing? - The date/time at which the requested service should occur.
- quantityRange Range? - An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
- priority AUBaseDiagnosticRequestPriority? - Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
- intent AUBaseDiagnosticRequestIntent - Whether the request is a proposal, plan, an original order or a reflex order.
- performerType CodeableConcept? - Desired type of performer for doing the requested service.
- bodySite CodeableConcept[]? - Anatomic location where the procedure should be performed. This is the target site.
- 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.
- occurrencePeriod Period? - The date/time at which the requested service should occur.
- 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.
- occurrenceDateTime dateTime? - The date/time at which the requested service should occur.
- orderDetail CodeableConcept[]? - Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
- category CodeableConcept[]? - A code that classifies the service for searching, sorting and display purposes (e.g. 'Surgical Procedure').
- locationCode CodeableConcept[]? - The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
- patientInstruction string? - Instructions in terms that are understood by the patient or consumer.
- status AUBaseDiagnosticRequestStatus - The status of the order.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseDiagnosticResult
FHIR AUBaseDiagnosticResult resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEDIAGNOSTICRESULT(default RESOURCE_NAME_AUBASEDIAGNOSTICRESULT) - 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[]? - An Extension
- extension Slicings
- Extension: Target anatomic location or structure
- min = 0
- max = 1
- 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.
- 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.
- component AUBaseDiagnosticResultComponent[]? - 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 AUBaseDiagnosticResultReferenceRange[]? - 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.
- status AUBaseDiagnosticResultStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseDiagnosticResultComponent
FHIR AUBaseDiagnosticResultComponent datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime time? - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.
- 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.aubase410: AUBaseDiagnosticResultReferenceRange
FHIR AUBaseDiagnosticResultReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- high Quantity? - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
- low Quantity? - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
- modifierExtension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple
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.aubase410: AUBaseEncounter
FHIR AUBaseEncounter resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEENCOUNTER(default RESOURCE_NAME_AUBASEENCOUNTER) - 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 = *
- Extension: Description, overview or summary of an encounter
- min = 0
- max = 1
- 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 AUBaseEncounterParticipant[]? - 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 AUBaseEncounterClassHistory[]? - 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 AUBaseEncounterHospitalization? - 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 AUBaseEncounterDiagnosis[]? - 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 AUBaseEncounterStatusHistory[]? - 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 AUBaseEncounterLocation[]? - 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 AUBaseEncounterStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseEncounterClassHistory
FHIR AUBaseEncounterClassHistory datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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.aubase410: AUBaseEncounterDiagnosis
FHIR AUBaseEncounterDiagnosis datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseEncounterHospitalization
FHIR AUBaseEncounterHospitalization datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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.aubase410: AUBaseEncounterLocation
FHIR AUBaseEncounterLocation datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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 AUBaseEncounterLocationStatus? - 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.aubase410: AUBaseEncounterParticipant
FHIR AUBaseEncounterParticipant datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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.aubase410: AUBaseEncounterStatusHistory
FHIR AUBaseEncounterStatusHistory datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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 AUBaseEncounterStatusHistoryStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
health.fhir.r4.aubase410: AUBaseHealthcareService
FHIR AUBaseHealthcareService resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEHEALTHCARESERVICE(default RESOURCE_NAME_AUBASEHEALTHCARESERVICE) - The type of the resource describes
- serviceProvisionCode CodeableConcept[]? - The code(s) that detail the conditions under which the healthcare service is available/offered.
- 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.
- specialty CodeableConcept[]? - Collection of specialties handled by the service site. This is more of a medical term.
- 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).
- eligibility AUBaseHealthcareServiceEligibility[]? - Does this service have specific eligibility requirements that need to be met in order to use the service?
- language code? - The base language in which the resource is written.
- program CodeableConcept[]? - Programs that this service is applicable to.
- 'type CodeableConcept[]? - The specific type of service that may be delivered or performed.
- characteristic CodeableConcept[]? - Collection of characteristics (attributes).
- notAvailable AUBaseHealthcareServiceNotAvailable[]? - The HealthcareService is not available during this period of time due to the provided reason.
- availableTime AUBaseHealthcareServiceAvailableTime[]? - A collection of times that the Service Site is available.
- endpoint Reference[]? - Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
- telecom ContactPoint[]? - List of contacts related to this specific healthcare 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.
- communication CodeableConcept[]? - Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.
- referralMethod CodeableConcept[]? - Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
- providedBy Reference? - The organization that provides this healthcare service.
- identifier Identifier[]|AuHpio[]|AuResidentialagedcareserviceidentifier[]? - External identifiers for this item.
- appointmentRequired boolean? - Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
- active boolean? - This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.
- photo Attachment? - If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
- 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 string? - Further description of the service as it would be presented to a consumer while searching.
- 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.
- comment string? - Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
- location Reference[]? - The location(s) where this healthcare service may be provided.
- category CodeableConcept[]? - Identifies the broad category of service being performed or delivered.
- extraDetails markdown? - Extra details about the service that can't be placed in the other fields.
- 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.
- coverageArea Reference[]? - The location(s) that this service is available to (not where the service is provided).
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseHealthcareServiceAvailableTime
FHIR AUBaseHealthcareServiceAvailableTime datatype record.
Fields
- Fields Included from *BackboneElement
- 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 AUBaseHealthcareServiceAvailableTimeDaysOfWeek[]? - 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.aubase410: AUBaseHealthcareServiceEligibility
FHIR AUBaseHealthcareServiceEligibility datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- code CodeableConcept? - Coded value for the eligibility.
- 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).
- comment markdown? - Describes the eligibility conditions for the service.
- 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.aubase410: AUBaseHealthcareServiceNotAvailable
FHIR AUBaseHealthcareServiceNotAvailable datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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.aubase410: AUBaseImmunisation
FHIR AUBaseImmunisation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEIMMUNISATION(default RESOURCE_NAME_AUBASEIMMUNISATION) - 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 AUBaseImmunisationEducation[]? - Educational material presented to the patient (or guardian) at the time of vaccine administration.
- doseQuantity Quantity? - 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 AUBaseImmunisationVaccineCode - 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 AUBaseImmunisationPerformer[]? - Indicates who performed the immunization event.
- performer Slicings
- AUBaseImmunisationPerformerApprovedBy: Immunisation Approved By
- min = 0
- max = 1
- AUBaseImmunisationPerformerAdministeredBy: Immunisation Administered By
- min = 0
- max = 1
- reaction AUBaseImmunisationReaction[]? - 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 AUBaseImmunisationProtocolApplied[]? - 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 AUBaseImmunisationStatus - Indicates the current status of the immunization event.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseImmunisationEducation
FHIR AUBaseImmunisationEducation datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseImmunisationPerformer
FHIR AUBaseImmunisationPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseImmunisationPerformerAdministeredBy
FHIR AUBaseImmunisationPerformerAdministeredBy datatype record.
Fields
- Fields Included from *BackboneElement
- 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 AUBaseImmunisationPerformerFunctionOne - 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.aubase410: AUBaseImmunisationPerformerApprovedBy
FHIR AUBaseImmunisationPerformerApprovedBy datatype record.
Fields
- Fields Included from *BackboneElement
- 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 AUBaseImmunisationPerformerFunction - 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.aubase410: AUBaseImmunisationPerformerFunction
FHIR AUBaseImmunisationPerformerFunction datatype record.
Fields
- Fields Included from *CodeableConcept
- coding AUBaseImmunisationPerformerFunctionCoding[] - A reference to a code defined by a terminology system.
health.fhir.r4.aubase410: AUBaseImmunisationPerformerFunctionCoding
FHIR AUBaseImmunisationPerformerFunctionCoding datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseImmunisationPerformerFunctionCodingOne
FHIR AUBaseImmunisationPerformerFunctionCodingOne datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseImmunisationPerformerFunctionOne
FHIR AUBaseImmunisationPerformerFunctionOne datatype record.
Fields
- Fields Included from *CodeableConcept
- coding AUBaseImmunisationPerformerFunctionCodingOne[] - A reference to a code defined by a terminology system.
health.fhir.r4.aubase410: AUBaseImmunisationProtocolApplied
FHIR AUBaseImmunisationProtocolApplied datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseImmunisationReaction
FHIR AUBaseImmunisationReaction datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseImmunisationVaccineCode
FHIR AUBaseImmunisationVaccineCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[]? - A reference to a code defined by a terminology system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.aubase410: AUBaseImmunisationVaccineCodeCodingAirVaccineCode
FHIR AUBaseImmunisationVaccineCodeCodingAirVaccineCode datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseImmunisationVaccineCodeCodingAmtVaccineCode
FHIR AUBaseImmunisationVaccineCodeCodingAmtVaccineCode datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseLocation
FHIR AUBaseLocation resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASELOCATION(default RESOURCE_NAME_AUBASELOCATION) - 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 AUBaseLocationHoursOfOperation[]? - 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 AUBaseLocationMode? - 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 AUBaseLocationPosition? - 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 AUBaseLocationStatus? - 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.aubase410: AUBaseLocationHoursOfOperation
FHIR AUBaseLocationHoursOfOperation datatype record.
Fields
- Fields Included from *BackboneElement
- 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 AUBaseLocationHoursOfOperationDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.
health.fhir.r4.aubase410: AUBaseLocationPosition
FHIR AUBaseLocationPosition datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseMedication
FHIR AUBaseMedication resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEMEDICATION(default RESOURCE_NAME_AUBASEMEDICATION) - 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 AUBaseMedicationCode? - 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 AUBaseMedicationIngredient[]? - 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 AUBaseMedicationBatch? - 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 AUBaseMedicationStatus? - A code to indicate if the medication is in active use.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseMedicationAdministration
FHIR AUBaseMedicationAdministration resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEMEDICATIONADMINISTRATION(default RESOURCE_NAME_AUBASEMEDICATIONADMINISTRATION) - The type of the resource describes
- dosage AUBaseMedicationAdministrationDosage? - Describes the medication dosage information details e.g. dose, rate, site, route, etc.
- instantiates uri[]? - A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
- note Annotation[]? - Extra information about the medication administration that is not conveyed by the other attributes.
- partOf Reference[]? - A larger event of which this particular event is a component or step.
- request Reference? - The original request, instruction or authority to perform the administration.
- 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.
- subject Reference - The person or animal or group receiving the medication.
- 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 administered.
- language code? - The base language in which the resource is written.
- medicationReference Reference? - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- statusReason CodeableConcept[]? - A code indicating why the administration was not performed.
- context Reference? - The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
- id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode CodeableConcept[]? - A code indicating why the medication was given.
- 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[]? - Identifiers associated with this Medication Administration 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.
- performer AUBaseMedicationAdministrationPerformer[]? - Indicates who or what performed the medication administration and how they were involved.
- effectivePeriod Period - A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
- supportingInformation Reference[]? - Additional information (for example, patient height and weight) that supports the administration of the medication.
- medicationCodeableConcept AUBaseMedicationAdministrationMedication? - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- 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.
- effectiveDateTime dateTime - A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
- 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[]? - A summary of the events of interest that have occurred, such as when the administration was verified.
- 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 where the medication is expected to be consumed or administered.
- device Reference[]? - The device used in administering the medication to the patient. For example, a particular infusion pump.
- status AUBaseMedicationAdministrationStatus - Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseMedicationAdministrationDosage
FHIR AUBaseMedicationAdministrationDosage datatype record.
Fields
- Fields Included from *BackboneElement
- dose Quantity? - The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
- 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.
- rateRatio Ratio? - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
- site CodeableConcept? - A coded specification of the anatomic site where the medication first entered the body. For example, 'left arm'.
- route CodeableConcept? - A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
- method CodeableConcept? - A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
- rateQuantity Quantity? - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
- 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.
- text string? - Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.
health.fhir.r4.aubase410: AUBaseMedicationAdministrationMedication
FHIR AUBaseMedicationAdministrationMedication datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[]? - A reference to a code defined by a terminology system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.aubase410: AUBaseMedicationAdministrationMedicationCodingAmt
FHIR AUBaseMedicationAdministrationMedicationCodingAmt datatype record.
Fields
- Fields Included from *Coding
- 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.
- medicationClass Extension? - The type of information covered by the medication coding, e.g. branded product with no strength or form.
health.fhir.r4.aubase410: AUBaseMedicationAdministrationMedicationCodingGtin
FHIR AUBaseMedicationAdministrationMedicationCodingGtin datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationAdministrationMedicationCodingMimsPackage
FHIR AUBaseMedicationAdministrationMedicationCodingMimsPackage datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationAdministrationMedicationCodingPbs
FHIR AUBaseMedicationAdministrationMedicationCodingPbs datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationAdministrationPerformer
FHIR AUBaseMedicationAdministrationPerformer datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - Indicates who or what performed the medication administration.
- 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 medication administration.
- 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.aubase410: AUBaseMedicationBatch
FHIR AUBaseMedicationBatch datatype record.
Fields
- Fields Included from *BackboneElement
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- 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.aubase410: AUBaseMedicationCode
FHIR AUBaseMedicationCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[]? - A reference to a code defined by a terminology system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. This may be a brand or generic name as suitable for the intent of the entry.
health.fhir.r4.aubase410: AUBaseMedicationCodeCodingAmt
FHIR AUBaseMedicationCodeCodingAmt datatype record.
Fields
- Fields Included from *Coding
- 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.
- medicationClass Extension? - The type of information covered by the medication coding, e.g. branded product with no strength or form.
health.fhir.r4.aubase410: AUBaseMedicationCodeCodingGtin
FHIR AUBaseMedicationCodeCodingGtin datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationCodeCodingMimsPackage
FHIR AUBaseMedicationCodeCodingMimsPackage datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationCodeCodingPbs
FHIR AUBaseMedicationCodeCodingPbs datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationDispense
FHIR AUBaseMedicationDispense resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEMEDICATIONDISPENSE(default RESOURCE_NAME_AUBASEMEDICATIONDISPENSE) - The type of the resource describes
- note Annotation[]? - Extra information about the dispense that could not be conveyed in the other attributes.
- partOf Reference[]? - The procedure that trigger the dispense.
- extension Extension[]? - An Extension
- extension Slicings
- Extension: Number of this dispense
- min = 0
- max = 1
- Extension: Grounds for concurrent supply of medication
- min = 0
- max = 1
- substitution AUBaseMedicationDispenseSubstitution? - Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
- subject Reference? - A link to a resource representing the person or the group 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).
- destination Reference? - Identification of the facility/location where the medication was shipped to, as part of the dispense event.
- language code? - The base language in which the resource is written.
- statusReasonReference Reference? - Indicates the reason why a dispense was not performed.
- statusReasonCodeableConcept CodeableConcept? - Indicates the reason why a dispense was not performed.
- 'type CodeableConcept? - Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
- medicationReference Reference? - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- context Reference? - The encounter or episode of care that establishes the context for this event.
- 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.
- authorizingPrescription Reference[]? - Indicates the medication order that is being dispensed against.
- identifier Identifier[]|AuLocaldispenseidentifier[]? - Identifiers associated with this Medication Dispense 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.
- performer AUBaseMedicationDispensePerformer[]? - Indicates who or what performed the event.
- quantity Quantity? - The amount of medication that has been dispensed. Includes unit of measure.
- 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.
- receiver Reference[]? - Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
- whenPrepared dateTime? - The time when the dispensed product was packaged and reviewed.
- daysSupply Quantity? - The amount of medication expressed as a timing amount.
- supportingInformation Reference[]? - Additional information that supports the medication being dispensed.
- whenHandedOver dateTime? - The time the dispensed product was provided to the patient or their representative.
- medicationCodeableConcept AUBaseMedicationDispenseMedication? - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- 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[]? - A summary of the events of interest that have occurred, such as when the dispense was verified.
- 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 principal physical location where the dispense was performed.
- category CodeableConcept? - Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- status AUBaseMedicationDispenseStatus - A code specifying the state of the set of dispense events.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseMedicationDispenseMedication
FHIR AUBaseMedicationDispenseMedication datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[]? - A reference to a code defined by a terminology system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. This may be a brand or generic name as suitable for the intent of the entry.
health.fhir.r4.aubase410: AUBaseMedicationDispenseMedicationCodingAmt
FHIR AUBaseMedicationDispenseMedicationCodingAmt datatype record.
Fields
- Fields Included from *Coding
- 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.
- medicationClass Extension? - The type of information covered by the medication coding, e.g. branded product with no strength or form.
health.fhir.r4.aubase410: AUBaseMedicationDispenseMedicationCodingGtin
FHIR AUBaseMedicationDispenseMedicationCodingGtin datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationDispenseMedicationCodingMimsPackage
FHIR AUBaseMedicationDispenseMedicationCodingMimsPackage datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationDispenseMedicationCodingPbs
FHIR AUBaseMedicationDispenseMedicationCodingPbs datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationDispensePerformer
FHIR AUBaseMedicationDispensePerformer datatype record.
Fields
- Fields Included from *BackboneElement
- actor Reference - The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser 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.
- 'function CodeableConcept? - Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.
- 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.aubase410: AUBaseMedicationDispenseSubstitution
FHIR AUBaseMedicationDispenseSubstitution datatype record.
Fields
- Fields Included from *BackboneElement
- reason CodeableConcept? - Indicates the reason for the substitution (or lack of substitution) from what was prescribed.
- 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.
- wasSubstituted boolean - True if the dispenser dispensed a different drug or product from what was prescribed.
- 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).
- responsibleParty Reference[]? - The person or organization that has primary responsibility for the substitution.
- 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? - A code signifying whether a different drug was dispensed from what was prescribed.
health.fhir.r4.aubase410: AUBaseMedicationIngredient
FHIR AUBaseMedicationIngredient datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseMedicationRequest
FHIR AUBaseMedicationRequest resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_AUBASEMEDICATIONREQUEST(default RESOURCE_NAME_AUBASEMEDICATIONREQUEST) - 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 AUBaseMedicationRequestSubstitution? - 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 AUBaseMedicationRequestDispenseRequest? - 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
- AUBaseMedicationRequestSupportingInformationBodyHeight: Observation of Body Height
- min = 0
- max = 1
- AUBaseMedicationRequestSupportingInformationBodyWeight: Observation of Body Weight
- 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 AUBaseMedicationRequestMedication? - 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 AUBaseMedicationRequestPriority? - Indicates how quickly the Medication Request should be addressed with respect to other requests.
- intent AUBaseMedicationRequestIntent - 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 AUBaseMedicationRequestStatus - A code specifying the current state of the order. Generally, this will be active or completed state.
- Element... - Rest field
health.fhir.r4.aubase410: AUBaseMedicationRequestDispenseRequest
FHIR AUBaseMedicationRequestDispenseRequest datatype record.
Fields
- Fields Included from *BackboneElement
- 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 AUBaseMedicationRequestDispenseRequestInitialFill? - 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.aubase410: AUBaseMedicationRequestDispenseRequestInitialFill
FHIR AUBaseMedicationRequestDispenseRequestInitialFill datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseMedicationRequestMedication
FHIR AUBaseMedicationRequestMedication datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[]? - A reference to a code defined by a terminology system.
- extension Extension[]? - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text string? - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. This may be a brand or generic name as suitable for the intent of the entry.
health.fhir.r4.aubase410: AUBaseMedicationRequestMedicationCodingAmt
FHIR AUBaseMedicationRequestMedicationCodingAmt datatype record.
Fields
- Fields Included from *Coding
- 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.
- medicationClass Extension? - The type of information covered by the medication coding, e.g. branded product with no strength or form.
health.fhir.r4.aubase410: AUBaseMedicationRequestMedicationCodingGtin
FHIR AUBaseMedicationRequestMedicationCodingGtin datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationRequestMedicationCodingMimsPackage
FHIR AUBaseMedicationRequestMedicationCodingMimsPackage datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationRequestMedicationCodingPbs
FHIR AUBaseMedicationRequestMedicationCodingPbs datatype record.
Fields
- Fields Included from *Coding
- 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.aubase410: AUBaseMedicationRequestSubstitution
FHIR AUBaseMedicationRequestSubstitution datatype record.
Fields
- Fields Included from *BackboneElement
- 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.aubase410: AUBaseMedicationRequestSupportingInformationBodyHeight
FHIR AUBaseMedicationRequestSupportingInformationBodyHeight datatype record.
Fields
- Fields Included from *Reference