Administrative Incubator
0.1.0 - International flag

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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Global Profiles

There are no Global profiles defined

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

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: * are included in the encounter compartment for the identified encounter (have a reference to the encounter) * are referenced by the standard extenstion for associating an encounter (where no reference element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter * the server believes are relevant to the context of the encounter for any other reason (internally defined/decided) * any resource referenced by the above, including binaries and attachments (to make a more complete package) 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: * are included in the episodeofcare compartment for the identified episodeofcare (have a reference to the episodeofcare) * are referenced by the standard extension for associating an episodeofcare (where no reference element exists) http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare * the server believes are relevant to the context of the episodeofcare for any other reason (internally defined/decided) * any resource referenced by the above, including binaries and attachments (to make a more complete package)

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.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

ChargeItemAccountSearchParam

Account to place this charge

ChargeItemCodeSearchParam

A code that identifies the charge, like a billing code

ChargeItemDefinitionAccountSearchParam

Candidate account for charge items

ChargeItemDefinitionContext-quantitySearchParam

A quantity- or range-valued use context assigned to the charge item definition

ChargeItemDefinitionContext-type-quantitySearchParam

A use context type and quantity- or range-based value assigned to the charge item definition

ChargeItemDefinitionContext-type-valueSearchParam

A use context type and value assigned to the charge item definition

ChargeItemDefinitionContext-typeSearchParam

A type of use context assigned to the charge item definition

ChargeItemDefinitionContextSearchParam

A use context assigned to the charge item definition

ChargeItemDefinitionDateSearchParam

The charge item definition publication date

ChargeItemDefinitionDescriptionSearchParam

The description of the charge item definition

ChargeItemDefinitionEffectiveSearchParam

The time during which the charge item definition is intended to be in use

ChargeItemDefinitionExperimentalSearchParam

Whether the ChargeItemDefinition is experimental

ChargeItemDefinitionIdentifierSearchParam

External identifier for the charge item definition

ChargeItemDefinitionJurisdictionSearchParam

Jurisdiction of the authority that maintains the the charge item definition

ChargeItemDefinitionPublisherSearchParam

Name of the publisher of the charge item definition

ChargeItemDefinitionStatusSearchParam

The current status of the charge item definition

ChargeItemDefinitionTitleSearchParam

The human-friendly name of the charge item definition

ChargeItemDefinitionUrlSearchParam

The uri that identifies the charge item definition

ChargeItemDefinitionVersionSearchParam

The business version of the charge item definition

ChargeItemEncounterSearchParam

Encounter associated with event

ChargeItemEntered-dateSearchParam

Date the charge item was entered

ChargeItemEntererSearchParam

Individual who was entering

ChargeItemFactor-overrideSearchParam

Factor overriding the associated rules

ChargeItemIdentifierSearchParam

Business Identifier for item

ChargeItemOccurrenceSearchParam

When the charged service was applied

ChargeItemPatientSearchParam

Individual service was done for/to

ChargeItemPerformer-actorSearchParam

Individual who was performing

ChargeItemPerformer-functionSearchParam

What type of performance was done

ChargeItemPerforming-organizationSearchParam

Organization providing the charged service

ChargeItemPrice-overrideSearchParam

Price overriding the associated rules

ChargeItemQuantitySearchParam

Quantity of which the charge item has been serviced

ChargeItemRequesting-organizationSearchParam

Organization requesting the charged service

ChargeItemServiceSearchParam

Which rendered service is being charged?

ChargeItemStatusSearchParam

Is this charge item active

ChargeItemSubjectSearchParam

Individual service was done for/to

EncounterHistoryEncounterSearchParam

The Encounter associated with this set of history values

EncounterHistoryIdentifierSearchParam

Identifier(s) by which this encounter is known

EncounterHistoryPatientSearchParam

The patient present at the encounter

EncounterHistoryStatusSearchParam

Status of the Encounter history entry

EncounterHistorySubjectSearchParam

The patient or group present at the encounter

InsurancePlanCoverage-areaSearchParam

Location(s) insurance product is intended for/available to

InsurancePlanIdentifierSearchParam

External identifiers for this item

InsurancePlanNetworkSearchParam

The product this plan is available to

InsurancePlanProductSearchParam

The product this plan is available to

InsurancePlanTypeSearchParam

A code for the type of insurance plan

InsuranceProductAdministered-bySearchParam

Product administrator

InsuranceProductContact-address-citySearchParam

A city specified in an address

InsuranceProductContact-address-countrySearchParam

A country specified in an address

InsuranceProductContact-address-postalcodeSearchParam

A postal code specified in an address

InsuranceProductContact-address-stateSearchParam

A state specified in an address

InsuranceProductContact-address-useSearchParam

A use code specified in an address

InsuranceProductContact-addressSearchParam

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

InsuranceProductEndpointSearchParam

Technical endpoint

InsuranceProductIdentifierSearchParam

Any identifier for the product (not the accreditation issuer's identifier)

InsuranceProductNameSearchParam

A portion of the insurance product's name or alias

InsuranceProductOwned-bySearchParam

The issuer of the insurance product

InsuranceProductPhoneticSearchParam

A portion of the product's name using some kind of phonetic matching algorithm

InsuranceProductStatusSearchParam

Is the Product record active

InsuranceProductTypeSearchParam

A code for the type of insurance product

PersonalRelationshipPatientSearchParam

The patient this related person is related to

PersonalRelationshipRelationshipSearchParam

The personal relationship between the patient and the PersonalRelationship

PersonalRelationshipSourceSearchParam

The source of the relationship

PersonalRelationshipTargetSearchParam

The target of the relationship

VerificationResultAttestation-methodSearchParam

Select validation information for data that was attested to using the specified method

VerificationResultAttestation-onbehalfofSearchParam

Select validation information for data that was attested to on behalf of the specified source

VerificationResultAttestation-whoSearchParam

Select validation information for data that was attested to by the specified source

VerificationResultPrimarysource-dateSearchParam

Select validation information for data that was validated against a primary source on the specified date

VerificationResultPrimarysource-typeSearchParam

Select validation information for data that was validated against the specified type of primary source organization

VerificationResultPrimarysource-whoSearchParam

Select validation information for data that was validated against the specified primary source

VerificationResultStatus-dateSearchParam

Select validation information with a validation status that occurred at the specified date/time

VerificationResultStatusSearchParam

Select validation information with the specified status

VerificationResultTargetSearchParam

A resource that was validated

VerificationResultValidator-organizationSearchParam

Select validation information for data that was validated by the specified organization

Structures: Additional Resources

'Additional' resources that are not yet published in the FHIR core specification.

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.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Benefit Cost Applicability

Whether the cost applies to in-network or out-of-network providers.

Benefit Cost Applicability

Whether the cost applies to in-network or out-of-network providers.

Charge Item Code

Example set of codes that can be used for billing purposes.

Charge Item Status

Codes identifying the lifecycle stage of a ChargeItem.

Insurance Plan Type

This example value set defines a set of codes that can be used to indicate a type of insurance plan.

Insurance Plan Type

This example value set defines a set of codes that can be used to indicate a type of insurance plan.

Invoice Price Component Type

Codes indicating the kind of the price component.

Personal Relationship Type

A set of codes that can be used to indicate the relationship between a PersonalRelationship's focus and target.

Verification Result status

The validation status of the target

VerificationResult Communication Method

Attested information may be validated by process that are manual or automated. For automated processes it may accomplished by the system of record reaching out through another system's API or information may be sent to the system of record. This value set defines a set of codes to describing the process, the how, a resource or data element is validated.

can-push-updates

Ability of the primary source to push updates/alerts

failure-action

The result if validation fails

need

The frequency with which the target must be validated

primary-source-type

Type of the validation primary source

push-type-available

Type of alerts/updates the primary source can send

validation-process

The primary process by which the target is validated

validation-status

Status of the validation of the target against the primary source

validation-type

What the target is validated against

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Charge Item Status

Codes identifying the lifecycle stage of a ChargeItem.

Invoice Price Component Type

Codes indicating the kind of the price component.

status

The validation status of the target

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

EncounterHistory/example
PersonalRelationship/example
Financial details for custom made device (345675)

Financial details for custom made device

Health Level Seven International Staff Plan
Sample Plan
ebm

Allergologisch-diagnostischer Komplex zur Diagnostik und/oder zum Ausschluss einer (Kontakt-)Allergie vom Spättyp (Typ IV), einschl. Kosten

example
example

Allergologisch-diagnostischer Komplex zur Diagnostik und/oder zum Ausschluss einer (Kontakt-)Allergie vom Spättyp (Typ IV), einschl. Kosten

example
example-onc
example1
foo
foo

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

OperationOutcome/apply-operation-response-example
ChargeItem-examples
ChargeItem-operations
ChargeItemDefinition-examples
ChargeItemDefinition-operations
EncounterHistory-examples
EncounterHistory-operations
InsurancePlan-examples
InsurancePlan-operations
InsuranceProduct-examples
InsuranceProduct-operations
PersonalRelationship-operations
VerificationResult-examples
VerificationResult-operations
personalrelationship-examples