FHIR R6 API Incubator
0.1.0 - ci-build International flag

FHIR R6 API Incubator, published by HL7 International / FHIR Infrastructure. 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/api-incubator-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

Contents:

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.

Access a list of profiles, tags, and security labels

This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope:

  • system-wide: a list of all profiles, tags and security labels in use by the system
  • resource-type level: A list of all profiles, tags, and security labels for the resource type
  • individual resource level: A list of all profiles, tags, and security labels for the current version of the resource. Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)
Add profiles, tags, and security labels to a resource

This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource
Add to an array in a large resource

Add content to an array in a large resource such as List or Group. See Operations for Large Resources.
Delete profiles, tags, and security labels for a resource

This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource
Filter an array in a large resource

Filter content from an array in a large resource such as List or Group. See Operations for Large Resources.
Find a functional list

This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list. The list of defined functional lists can be found at Current Resource Lists. Applications are not required to support all the lists, and may define additional lists of their own. If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)
Remove from an array in a large resource

Remove content from an array in a large resource such as List or Group. See Operations for Large Resources.
Return a graph of resources

Return an entire graph of resources based on a GraphDefinition. The operation is invoked on a specific instance of a resource, and the graph definition tells the server what other resources to return in the same packaage

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.

GraphDefinitionContextQuantitySearchParam

A quantity- or range-valued use context assigned to the graph definition
GraphDefinitionContextSearchParam

A use context assigned to the graph definition
GraphDefinitionContextTypeQuantitySearchParam

A use context type and quantity- or range-based value assigned to the graph definition
GraphDefinitionContextTypeSearchParam

A type of use context assigned to the graph definition
GraphDefinitionContextTypeValueSearchParam

A use context type and value assigned to the graph definition
GraphDefinitionDateSearchParam

The graph definition publication date
GraphDefinitionDescriptionSearchParam

The description of the graph definition
GraphDefinitionExperimentalSearchParam

Whether the GraphDefinition is experimental
GraphDefinitionIdentifierSearchParam

External identifier for the graph definition
GraphDefinitionJurisdictionSearchParam

Jurisdiction of the authority that maintains the the graph definition
GraphDefinitionNameSearchParam

Computationally friendly name of the graph definition
GraphDefinitionPublisherSearchParam

Name of the publisher of the graph definition
GraphDefinitionStartSearchParam

Type of resource at which the graph starts
GraphDefinitionStatusSearchParam

The current status of the graph definition
GraphDefinitionUrlSearchParam

The uri that identifies the graph definition
GraphDefinitionVersionSearchParam

The business version of the graph definition

Terminology: Value Sets

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

Graph Compartment Rule ValueSet

How a compartment must be linked.
Graph Compartment Use ValueSet

Defines how a compartment rule is used.

Terminology: Code Systems

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

Graph Compartment Rule

How a compartment must be linked.
Graph Compartment Use

Defines how a compartment rule is used.

Example: Example Instances

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

DocumentGenerationTemplate

Specify to include list references when generating a document using the $document operation

Other

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

Graph Definition

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
GraphDefinition-examples

A set of GraphDefinition resources that illustrate the use of the $graph operation. These examples are not normative, and are not intended to be used as test cases.
GraphDefinition-operations

All the GraphDefinition operations available in this guide.