Administrative Incubator, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/admin-incubator/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/admin-incubator/ImplementationGuide/hl7.fhir.uv.admin-incubator | Version: 0.1.0 | |||
| IG Standards status: Trial-use Active as of 2025-11-08 | Maturity Level: 3 | Computable Name: AdministrativeIncubator | ||
This Additional Resources Incubator Implementation Guide (IG) defines FHIR resources that require additional review and enhancement before becoming normative content and included in a future version of the FHIR specification. We welcome and encourage all feedback on this content.
| Charge Item | The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation. |
| Charge Item Definition | The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system. |
| EncounterHistory | A record of significant events/milestones key data throughout the history of an Encounter |
| Insurance Plan | Details of a Health Insurance plan provided by an organization under an InsuranceProduct. |
| Insurance Product | Details of a Health Insurance product provided by an organization. |
| Personal Relationship | Details about the relationship between 2 individuals. |
| Verification Result | Describes validation requirements, source(s), status and dates for one or more elements. |
| Apply | The apply operation applies a definition in a specific context |
| Fetch Encounter Record | This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display). The server SHOULD return all resources it has that:
Implementation guides may make additional rules about how much information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?) |
| Fetch EpisodeOfCare Record | This operation is used to return all the information related to an episodeofcare described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the episodeofcare resource itself is returned, along with any other resources that the server has available for the given episodeofcare for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an episodeofcare for efficient display). The server SHOULD return all resources it has that:
|
| Fetch Patient Record | This operation is used to return all the information related to one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. The intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. The server SHOULD resolve version-specific references by returning the explicitly named version. Implementation guides may make additional rules about how much information that is returned. |
| Patient Merge | The merge operation is used to request two patient resources be merged. One of the two patients is identified as the source and one as the target. The data from the source patient will be merged with the data of the target patient. The source Patient resource will be updated to add a new Patient.link reference to the target Patient resource with a link-type of replaced-by. The source Patient will also be updated to have a status of inactive, unless the source Patient resource was deleted. The target Patient resource will be updated to add a new Patient.link reference to the source Patient resource with a link-type of replaces unless the source Patient resource is deleted. The target Patient resource must be included in the result-patient parameter if used. |
| IG | Package | FHIR | Comment |
|---|---|---|---|
| hl7.fhir.uv.admin-incubator#0.1.0 | R6 | ||
| hl7.terminology.r5#6.5.0 | R5 | Automatically added as a dependency - all IGs depend on HL7 Terminology | |
| hl7.fhir.uv.extensions.r5#5.2.0 | R5 | ||
| hl7.fhir.uv.tools.r5#0.8.0 | R5 | for example references |
Package hl7.fhir.uv.extensions.r5#5.2.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00) |
Package hl7.fhir.uv.tools.r5#0.8.0 This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Aug 5, 2025 20:09+1000+10:00) |
There are no Global profiles defined
This publication includes IP covered under the following statements.