Module health.fhir.r4.be.lab100
ballerinax/health.fhir.r4.be.lab100 Ballerina library
1.0.0
Ballerina package containing FHIR resource data models compliant with https://www.ehealth.fgov.be/standards/fhir/lab/ implementation guide.
FHIR R4 health_fhir_r4_be_lab100 package
Package Overview
| FHIR version | R4 |
| Implementation Guide | https://www.ehealth.fgov.be/standards/fhir/lab/ |
Note: This package only supports FHIR JSON payload format only. FHIR XML payload support will be added soon.
Capabilities and features
Supported FHIR resource types
| 1). BeLaboratoryReport | [Definition] [Ballerina Record] |
| 2). BeLaboratoryReportComposition | [Definition] [Ballerina Record] |
| 3). BeSpecimenLaboratory | [Definition] [Ballerina Record] |
| 4). BeObservationLaboratory | [Definition] [Ballerina Record] |
Functions
initialize
Isolated Function
function initialize()This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.be.lab100: PROFILE_BASE_BELABORATORYREPORT
health.fhir.r4.be.lab100: PROFILE_BASE_BELABORATORYREPORTCOMPOSITION
health.fhir.r4.be.lab100: PROFILE_BASE_BEOBSERVATIONLABORATORY
health.fhir.r4.be.lab100: PROFILE_BASE_BESPECIMENLABORATORY
health.fhir.r4.be.lab100: RESOURCE_NAME_BELABORATORYREPORT
health.fhir.r4.be.lab100: RESOURCE_NAME_BELABORATORYREPORTCOMPOSITION
health.fhir.r4.be.lab100: RESOURCE_NAME_BEOBSERVATIONLABORATORY
health.fhir.r4.be.lab100: RESOURCE_NAME_BESPECIMENLABORATORY
Enums
health.fhir.r4.be.lab100: BeLaboratoryReportCompositionAttesterMode
BeLaboratoryReportCompositionAttesterMode enum
Members
CODE_MODE_LEGAL
CODE_MODE_OFFICIAL
CODE_MODE_PERSONAL
CODE_MODE_PROFESSIONAL
health.fhir.r4.be.lab100: BeLaboratoryReportCompositionRelatesToCode
BeLaboratoryReportCompositionRelatesToCode enum
Members
CODE_CODE_SIGNS
CODE_CODE_REPLACES
CODE_CODE_TRANSFORMS
CODE_CODE_APPENDS
health.fhir.r4.be.lab100: BeLaboratoryReportCompositionSectionMode
BeLaboratoryReportCompositionSectionMode enum
Members
CODE_MODE_CHANGES
CODE_MODE_WORKING
CODE_MODE_SNAPSHOT
health.fhir.r4.be.lab100: BeLaboratoryReportCompositionStatus
BeLaboratoryReportCompositionStatus enum
Members
CODE_STATUS_AMENDED
CODE_STATUS_FINAL
CODE_STATUS_PRELIMINARY
CODE_STATUS_ENTERED_IN_ERROR
health.fhir.r4.be.lab100: BeLaboratoryReportCompositionTextStatus
BeLaboratoryReportCompositionTextStatus enum
Members
CODE_STATUS_EXTENSIONS
CODE_STATUS_GENERATED
CODE_STATUS_ADDITIONAL
CODE_STATUS_EMPTY
health.fhir.r4.be.lab100: BeLaboratoryReportIdentifierUse
BeLaboratoryReportIdentifierUse enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.lab100: BeLaboratoryReportTextStatus
BeLaboratoryReportTextStatus enum
Members
CODE_STATUS_EXTENSIONS
CODE_STATUS_GENERATED
CODE_STATUS_ADDITIONAL
CODE_STATUS_EMPTY
health.fhir.r4.be.lab100: BeObservationLaboratoryStatus
BeObservationLaboratoryStatus enum
Members
CODE_STATUS_AMENDED
CODE_STATUS_FINAL
CODE_STATUS_REGISTERED
CODE_STATUS_PRELIMINARY
health.fhir.r4.be.lab100: BeObservationLaboratoryTextStatus
BeObservationLaboratoryTextStatus enum
Members
CODE_STATUS_EXTENSIONS
CODE_STATUS_GENERATED
CODE_STATUS_ADDITIONAL
CODE_STATUS_EMPTY
health.fhir.r4.be.lab100: BeSpecimenLaboratoryStatus
BeSpecimenLaboratoryStatus enum
Members
CODE_STATUS_UNAVAILABLE
CODE_STATUS_AVAILABLE
CODE_STATUS_UNSATISFACTORY
CODE_STATUS_ENTERED_IN_ERROR
health.fhir.r4.be.lab100: BeSpecimenLaboratoryTextStatus
BeSpecimenLaboratoryTextStatus enum
Members
CODE_STATUS_EXTENSIONS
CODE_STATUS_GENERATED
CODE_STATUS_ADDITIONAL
CODE_STATUS_EMPTY
Variables
health.fhir.r4.be.lab100: terminologyProcessor
Terminology processor instance
health.fhir.r4.be.lab100: fhirRegistry
FHIR registry instance
health.fhir.r4.be.lab100: FHIR_VALUE_SETS
health.fhir.r4.be.lab100: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.be.lab100: BeLaboratoryReport
FHIR BeLaboratoryReport resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BELABORATORYREPORT(default RESOURCE_NAME_BELABORATORYREPORT) - The type of the resource describes
- extension? Extension[] - An 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? BeLaboratoryReportMedia[] - 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? BeLaboratoryReportText - 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 the prescription this laboratory report fullfills. A reference to a ServiceRequest SHALL be given here that includes the time of prescription in its .authoredOn element. It is RECOMMENDED to also use the .identifier element of the ServiceRequest to identify the original order number. Note, within the Observation resource it is possible to define they were defined on a different serviceRequest (e.g. to clarify it was a sub ordering)
- identifier Identifier[] - An identifier for this laboratory report. This identifier will be used to determine if a new resource is needed, or if this resource is an update of an existing one. When an identifier is given, a consumer SHALL NOT ignore it.
- identifier Slicings
- BeLaboratoryReportIdentifierDRID: Business identifier for report
- min = 1
- max = 1
- performer Reference[] - The diagnostic service that is responsible for issuing the report. In the laboratory report, this is typically an organization (i.e. the laboratory) Note the Observation MAY have a different performer.
- effectivePeriod? Period - The time or time-period the observed values are related to. This is the time specimen collection(s)
- 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. This is the time specimen collection(s)
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- 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 BeLaboratoryReportCategory[] - The subject of this specialty, expressed in a LOINC code. The choice of what observations to categorize under what specialty are left ultimately to the discretion of the laboratory sending the results. Some non-restrictive guidelines: *18721-1 (THERAPEUTIC DRUG MONITORING STUDIES) will be used for a section carrying pharmacologyobservations on a patient. *Mycology and parasitology, as well as bacteriology, are part of the 18725-2 (MICROBIOLOGY STUDIES) specialty. *665 Virology MAY be included in 18725-2 (MICROBIOLOGY STUDIES) specialty or 18727-8 (SEROLOGY STUDIES)or split between both specialties, depending upon the Content Creator Actor’s choice
- 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 code - The status of the diagnostic report. Consult the HL7 list of allowed values here. Note when a report should actually replace a previous one, use the Replaces extension.
- Element... - Rest field
health.fhir.r4.be.lab100: BeLaboratoryReportCategory
Closed record
FHIR BeLaboratoryReportCategory datatype record.
Fields
- Fields Included from *CodeableConcept
- coding Coding[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.lab100: BeLaboratoryReportCategoryCodingLABREPORT
Closed record
FHIR BeLaboratoryReportCategoryCodingLABREPORT 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 "LAB") - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "http://terminology.hl7.org/CodeSystem/v2-0074") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display string(default "Laboratory") - 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.be.lab100: BeLaboratoryReportComposition
FHIR BeLaboratoryReportComposition resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BELABORATORYREPORTCOMPOSITION(default RESOURCE_NAME_BELABORATORYREPORTCOMPOSITION) - 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[] - 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.
- custodian? Reference - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
- 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 BeLaboratoryReportCompositionSection[] - 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? BeLaboratoryReportCompositionAttester[] - 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? BeLaboratoryReportCompositionText - 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? BeLaboratoryReportCompositionEvent[] - The clinical service, such as a colonoscopy or an appendectomy, being documented.
- relatesTo? BeLaboratoryReportCompositionRelatesTo[] - Relationships that this composition has with other compositions or documents that already exist.
- status BeLaboratoryReportCompositionStatus - 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.be.lab100: BeLaboratoryReportCompositionAttester
Closed record
FHIR BeLaboratoryReportCompositionAttester datatype record.
Fields
- Fields Included from *BackboneElement
- mode BeLaboratoryReportCompositionAttesterMode - 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.be.lab100: BeLaboratoryReportCompositionEvent
Closed record
FHIR BeLaboratoryReportCompositionEvent 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.be.lab100: BeLaboratoryReportCompositionRelatesTo
Closed record
FHIR BeLaboratoryReportCompositionRelatesTo 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 BeLaboratoryReportCompositionRelatesToCode - 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.be.lab100: BeLaboratoryReportCompositionSection
Closed record
FHIR BeLaboratoryReportCompositionSection 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 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.
- 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).
- section? CompositionSection[] - A nested sub-section within this section.
- 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.
- mode? BeLaboratoryReportCompositionSectionMode - 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.
- orderedBy? CodeableConcept - Specifies the order applied to the items in the section entries.
- 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.
health.fhir.r4.be.lab100: BeLaboratoryReportCompositionText
Closed record
FHIR BeLaboratoryReportCompositionText datatype record.
Fields
- Fields Included from *Narrative
- div xhtml - The actual narrative content, a stripped down version of XHTML.
- 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.
- status BeLaboratoryReportCompositionTextStatus - The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
health.fhir.r4.be.lab100: BeLaboratoryReportIdentifierDRID
Closed record
FHIR BeLaboratoryReportIdentifierDRID datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- 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 identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/lab-report/diagnostic-report-id") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BeLaboratoryReportIdentifierUse - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- 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 coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.lab100: BeLaboratoryReportMedia
Closed record
FHIR BeLaboratoryReportMedia 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.be.lab100: BeLaboratoryReportText
Closed record
FHIR BeLaboratoryReportText datatype record.
Fields
- Fields Included from *Narrative
- div xhtml - The actual narrative content, a stripped down version of XHTML.
- 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.
- status BeLaboratoryReportTextStatus - The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
health.fhir.r4.be.lab100: BeObservationLaboratory
FHIR BeObservationLaboratory resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEOBSERVATIONLABORATORY(default RESOURCE_NAME_BEOBSERVATIONLABORATORY) - 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? CodedAnnotation[] - A text note which also contains information about who made the statement and when.
- partOf? Reference[] - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code BeObservationLaboratoryCode - Describes what was observed. Sometimes this is called the observation 'name'. For providing systems, it is RECOMMENDED to express this using a code and consuming software SHALL record this. In general, it shall be noted SNOMED-CT is the preferred national terminology. Other coding systems remain allowed or MAY be preferred in specific flows (e.g. the use of LOINC codes to express a laboratory test.)
- subject? Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focuselement or thecodeitself specifies the actual focus of the observation.
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- focus? Reference[] - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- language? code - The base language in which the resource is written.
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- specimen? Reference - The specimen that was used when this observation was made.
- derivedFrom? Reference[] - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? BeObservationLaboratoryText - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- issued? instant - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- basedOn? Reference[] - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
- identifier? Identifier[] - A unique identifier assigned to this observation.
- performer? Reference[] - Who was responsible for asserting the observed value as 'true'.
- effectivePeriod? Period - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- effectiveTiming? Timing - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- method? CodeableConcept - Indicates the mechanism used to perform the observation.
- hasMember? Reference[] - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- encounter? Reference - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- bodySite? CodeableConcept - Indicates the site on the subject's body where the observation was made (i.e. the target site).
- component? BeObservationLaboratoryComponent[] - 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.
- component Slicings
- BeObservationLaboratoryComponentProductNameQualifier: If a testing code does not include a product name but needs one to qualify the code
- min = 0
- max = 1
- contained? Resource[] - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- referenceRange? BeObservationLaboratoryReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two
referenceRangeelements would be used.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- effectiveDateTime? dateTime - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- meta? Meta - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- implicitRules? uri - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- category? CodeableConcept[] - A code that classifies the general type of observation being made.
- device? Reference - The device used to generate the observation data.
- effectiveInstant? instant - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- status BeObservationLaboratoryStatus - The status of the result value.
- Element... - Rest field
health.fhir.r4.be.lab100: BeObservationLaboratoryCode
Closed record
FHIR BeObservationLaboratoryCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? Coding[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.lab100: BeObservationLaboratoryCodeCodingLOINC
Closed record
FHIR BeObservationLaboratoryCodeCodingLOINC 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://loinc.org") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.be.lab100: BeObservationLaboratoryCodeCodingSNOMED_CT
Closed record
FHIR BeObservationLaboratoryCodeCodingSNOMED_CT 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.be.lab100: BeObservationLaboratoryComponent
Closed record
FHIR BeObservationLaboratoryComponent datatype record.
Fields
- Fields Included from *BackboneElement
- valueBoolean? boolean - The information determined as a result of making the observation, if the information has a simple value.
- dataAbsentReason? CodeableConcept - Provides a reason why the expected value in the element Observation.component.value[x] is missing.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- valueTime? time - The information determined as a result of making the observation, if the information has a simple value.
- code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.
- valueRange? Range - The information determined as a result of making the observation, if the information has a simple value.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- valueCodeableConcept? CodeableConcept - The information determined as a result of making the observation, if the information has a simple value.
- valueRatio? Ratio - The information determined as a result of making the observation, if the information has a simple value.
- referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range.
- valueString? string - The information determined as a result of making the observation, if the information has a simple value.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- valueSampledData? SampledData - The information determined as a result of making the observation, if the information has a simple value.
- valuePeriod? Period - The information determined as a result of making the observation, if the information has a simple value.
- valueDateTime? dateTime - The information determined as a result of making the observation, if the information has a simple value.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueInteger? integer - The information determined as a result of making the observation, if the information has a simple value.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.be.lab100: BeObservationLaboratoryComponentCode
Closed record
FHIR BeObservationLaboratoryComponentCode datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? BeObservationLaboratoryComponentCodeCoding[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.lab100: BeObservationLaboratoryComponentCodeCoding
Closed record
FHIR BeObservationLaboratoryComponentCodeCoding 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 "774167006") - 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(default "Product name") - 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.be.lab100: BeObservationLaboratoryComponentCodeCodingOne
Closed record
FHIR BeObservationLaboratoryComponentCodeCodingOne 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 "118578006") - 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(default "Relative time") - 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.be.lab100: BeObservationLaboratoryComponentCodeCodingTwo
Closed record
FHIR BeObservationLaboratoryComponentCodeCodingTwo 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 "118555000") - 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(default "Substance amount") - 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.be.lab100: BeObservationLaboratoryComponentCodeOne
Closed record
FHIR BeObservationLaboratoryComponentCodeOne datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? BeObservationLaboratoryComponentCodeCodingOne[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.lab100: BeObservationLaboratoryComponentCodeTwo
Closed record
FHIR BeObservationLaboratoryComponentCodeTwo datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? BeObservationLaboratoryComponentCodeCodingTwo[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.lab100: BeObservationLaboratoryComponentProductNameQualifier
Closed record
FHIR BeObservationLaboratoryComponentProductNameQualifier datatype record.
Fields
- Fields Included from *BeObservationLaboratoryComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- referenceRange ObservationReferenceRange[]
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element|Element[]...
- valueCodeableConcept? CodeableConcept - 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.
- referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range.
- code BeObservationLaboratoryComponentCode - Describes what was observed. Sometimes this is called the observation 'code'.
- 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.
- 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.be.lab100: BeObservationLaboratoryComponentRelativeTimeQualifier
Closed record
FHIR BeObservationLaboratoryComponentRelativeTimeQualifier datatype record.
Fields
- Fields Included from *BeObservationLaboratoryComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- referenceRange ObservationReferenceRange[]
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element|Element[]...
- 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.
- referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range.
- code BeObservationLaboratoryComponentCodeOne - Describes what was observed. Sometimes this is called the observation 'code'.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.be.lab100: BeObservationLaboratoryComponentSubstanceAmountQualifier
Closed record
FHIR BeObservationLaboratoryComponentSubstanceAmountQualifier datatype record.
Fields
- Fields Included from *BeObservationLaboratoryComponent
- valueBoolean boolean
- dataAbsentReason CodeableConcept
- extension Extension[]
- valueTime time
- code CodeableConcept
- valueRange Range
- modifierExtension Extension[]
- valueCodeableConcept CodeableConcept
- valueRatio Ratio
- referenceRange ObservationReferenceRange[]
- valueString string
- interpretation CodeableConcept[]
- valueSampledData SampledData
- valuePeriod Period
- valueDateTime dateTime
- id string
- valueInteger integer
- valueQuantity Quantity
- Element|Element[]...
- 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.
- referenceRange? ObservationReferenceRange[] - Guidance on how to interpret the value by comparison to a normal or recommended range.
- code BeObservationLaboratoryComponentCodeTwo - Describes what was observed. Sometimes this is called the observation 'code'.
- interpretation? CodeableConcept[] - A categorical assessment of an observation value. For example, high, low, normal.
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- valueQuantity? Quantity - The information determined as a result of making the observation, if the information has a simple value.
health.fhir.r4.be.lab100: BeObservationLaboratoryReferenceRange
Closed record
FHIR BeObservationLaboratoryReferenceRange datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - An Extension
- high? Quantity - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
- low? Quantity - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
- modifierExtension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- appliesTo? CodeableConcept[] - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple
appliesToare interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.
- 'type? CodeableConcept - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
- age? Range - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
health.fhir.r4.be.lab100: BeObservationLaboratoryText
Closed record
FHIR BeObservationLaboratoryText datatype record.
Fields
- Fields Included from *Narrative
- div xhtml - The actual narrative content, a stripped down version of XHTML.
- 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.
- status BeObservationLaboratoryTextStatus - The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
health.fhir.r4.be.lab100: BeSpecimenLaboratory
FHIR BeSpecimenLaboratory resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BESPECIMENLABORATORY(default RESOURCE_NAME_BESPECIMENLABORATORY) - The type of the resource describes
- container? BeSpecimenLaboratoryContainer[] - The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
- accessionIdentifier? Identifier - The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
- identifier? Identifier[] - Business identifier for specimen is RECOMMENDED to include when available.
- note? Annotation[] - To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
- parent? Reference[] - Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
- request? Reference[] - Details concerning a service request that required a specimen to be collected.
- 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 - Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
- 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.
- collection? BeSpecimenLaboratoryCollection - Details concerning the specimen collection.
- 'type? CodeableConcept - The kind of material that forms the specimen. RECOMMENDED to include.
- condition? CodeableConcept[] - A mode or state of being that describes the nature of the specimen.
- 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.
- receivedTime? dateTime - Time when specimen was received for processing or testing.
- 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.
- processing? BeSpecimenLaboratoryProcessing[] - Details concerning processing and processing steps for the specimen.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? BeSpecimenLaboratoryText - 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? BeSpecimenLaboratoryStatus - The availability of the specimen.
- Element... - Rest field
health.fhir.r4.be.lab100: BeSpecimenLaboratoryCollection
Closed record
FHIR BeSpecimenLaboratoryCollection datatype record.
Fields
- Fields Included from *BackboneElement
- duration? Duration - The span of time over which the collection of a specimen occurred.
- bodySite? CodeableConcept - Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
- 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.
- fastingStatusDuration? Duration - Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
- quantity? Quantity - The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
- collectedPeriod? Period - Time when specimen was collected from subject - the physiologically relevant time.
- method? CodeableConcept - A coded value specifying the technique that is used to perform the procedure.
- collectedDateTime? dateTime - Time when specimen was collected from subject - the physiologically relevant time.
- 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).
- fastingStatusCodeableConcept? CodeableConcept - Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- collector? Reference - Person who collected the specimen.
health.fhir.r4.be.lab100: BeSpecimenLaboratoryContainer
Closed record
FHIR BeSpecimenLaboratoryContainer datatype record.
Fields
- Fields Included from *BackboneElement
- identifier? Identifier[] - Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.
- specimenQuantity? Quantity - The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
- 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 - Textual description of the container.
- 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 type of container associated with the specimen (e.g. slide, aliquot, etc.).
- additiveReference? Reference - Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- additiveCodeableConcept? CodeableConcept - Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- capacity? Quantity - The capacity (volume or other measure) the container may contain.
health.fhir.r4.be.lab100: BeSpecimenLaboratoryProcessing
Closed record
FHIR BeSpecimenLaboratoryProcessing 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).
- timePeriod? Period - A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
- description? string - Textual description of procedure.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- procedure? CodeableConcept - A coded value specifying the procedure used to process the specimen.
- timeDateTime? dateTime - A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
- additive? Reference[] - Material used in the processing step.
health.fhir.r4.be.lab100: BeSpecimenLaboratoryText
Closed record
FHIR BeSpecimenLaboratoryText datatype record.
Fields
- Fields Included from *Narrative
- div xhtml - The actual narrative content, a stripped down version of XHTML.
- 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.
- status BeSpecimenLaboratoryTextStatus - The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
health.fhir.r4.be.lab100: CodedAnnotation
Closed record
Fields
- Fields Included from *Annotation
- id? string -
- extension? Extension[] -
- time? dateTime -
- text markdown -
Import
import ballerinax/health.fhir.r4.be.lab100;Other versions
1.0.0