Canonical URL of the GraphDefinition when invoked at the resource type level. This is exclusive with the graphDefinition parameter.

Version of the GraphDefinition when invoked at the resource type level. This is exclusive with the graphDefinition parameter.

The graph definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, either this parameter or url (and optionally version) must be supplied.

Subject(s) for which the graph definition will be realized. Subjects provided in this parameter SHALL match the type given by the start element of the GraphDefinition being applied. For example, if the start is Patient, the subject is a reference to a Patient, or a Group of Patients. This parameter cannot be used with the subjectGroup parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server.

Subjects for which the graph definition will be realized, provided as a Group resource. Subjects provided in this parameter SHALL match the type given by the start element of the GraphDefinition being applied. For example, if the start is Patient, the Group is a Group of Patients. This parameter cannot be used with the subject parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server.

The encounter in context, if any

The practitioner applying the graph definition

The organization applying the graph definition

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)

Preferred language of the person using the system

The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources

The current setting of the request (inpatient, outpatient, etc.)

Additional detail about the setting of the request, if any

Any input parameters defined in libraries referenced by the GraphDefinition. Parameter types are mapped to CQL as specified in the Using CQL With FHIR implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.

Whether to use data from the server performing the evaluation. If this parameter is true (the default), then the operation will use data first from any bundles provided as parameters (through the data and prefetch parameters), second data from the server performing the operation, and third, data from the dataEndpoint parameter (if provided). If this parameter is false, the operation will use data first from the bundles provided in the data or prefetch parameters, and second from the dataEndpoint parameter (if provided).

Data to be made available to the GraphDefinition evaluation. This parameter is exclusive with the prefetchData parameter (i.e. either provide all data as a single bundle, or provide data using multiple bundles with prefetch descriptions).

Data to be made available to the GraphDefinition evaluation, organized as prefetch response bundles. Each prefetchData parameter specifies either the name of the prefetchKey it is satisfying, a DataRequirement describing the prefetch, or both.

The key of the prefetch item. This typically corresponds to the name of a parameter in a library, or the name of a prefetch item in a CDS Hooks discovery response

A DataRequirement describing the content of the prefetch item.

The prefetch data as a Bundle. If the prefetchData has no prefetchResult part, it indicates there is no data associated with this prefetch item.

An endpoint to use to access data referenced by retrieve operations in libraries referenced by the GraphDefinition. If provided, this endpoint is used after the data or prefetchData bundles, and the server, if the useServerData parameter is true.

Configuration information to resolve canonical artifacts

Processing Semantics:

Create a canonical-like reference (e.g. {canonical.url}|{canonical.version} or similar extensions for non-canonical artifacts).

• Given a single artifactEndpointConfiguration
  • When artifactRoute is present
    • And the canonical or artifact reference starts with the artifactRoute (up to and including the entire uri)
    • Then attempt to resolve with endpointUri or endpoint
  • When artifactRoute is not present
    • Then attempt to resolve with endpointUri or endpoint
• Given multiple artifactEndpointConfigurations
  • Then rank order each configuration (see below)
  • And attempt to resolve with endpointUri or endpoint in order until resolved

Rank each artifactEndpointConfiguration such that:

• if artifactRoute is present and artifactRoute starts with canonical or artifact reference: rank based on number of matching characters
• if artifactRoute is not present: include but rank lower

NOTE: For evenly ranked artifactEndpointConfigurations, order as defined in the OperationDefinition.

An optional route used to determine whether this endpoint is expected to be able to resolve artifacts that match the route (i.e. start with the route, up to and including the entire url)

The URI of the endpoint, exclusive with the endpoint parameter

An Endpoint resource describing the endpoint, exclusive with the endpointUri parameter

A Bundle for each input subject, with a Composition resource as the first entry. The Composition is the result of realizing the graph definition with respect to that subject, and identifies the graph definition using the cpg-generatedFrom extension.