This structure is defined to allow the FHIR Validator to validate a CDSHooks Request Context. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks order-select context. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks Order-Sign context. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks Patient-View context. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks Request Body. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks Services Element with Extensions. TODO: This content will be moved to the CDS Hooks specification in the future

This structure is defined to allow the FHIR Validator to validate a CDSHooks Services response body. TODO: This content will be moved to the CDS Hooks specification in the future

An example URL used to refer to examples associated with this actor. This is used when an IG describes a federated system with multiple servers playing the roles of different actors. Note that this is for example references, and has no impact on the canonical URLs defined by the IG

Used to associate an example in an IG with a particular actor that provides/serves this example (e.g. on a RESTful API)

Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

This extension specifies the format (= mime type) of a binary resource, when the binary resource is provided to the IG publisher as raw content (rather than as a FHIR binary resource with base64 content).

This extension specifies a logical model to use to validate the binary contents.

This provides a definition for a binding. There’s really no functional difference between a definition and a description, and this extension will be removed in R6. No tools do anything with the binding definitions (they use binding.description instead).

The date format, as a Java date/time format (todo: extract a common subset from FHIRPath? Java? DotNet? Windows API?)

A set of colon delimited codes that control the execution of specific valdation rules for date(/time) elements. The code tz-for-time controls whether the rule that there must be a timezone if there’s a time is enforced - in it’s absence, the rule is not enforced. The code year-valid controls whether the year is checked for being in the range 1800 -> now + 80 year - in it’s absence, the rule is not enforced. If the extension is not present, the rules are enforced. This extension has no effect on data types and resources, only in logical models

A URI defined in the IG that is (or may be) the target of an element with type URI. A typical use is for consent policies.

How the type can be extended. Note that all FHIR types that inherit from Element have extension-style = fhir-extensions

This extension provides a comment explaining the why an IG depends on another IG.

A package (id#ver) that this IG has an internal dependency on. A internal dependency is a package that is required to validate the resources in the IG itself but that is not required by the implementers of the IG

A package (id#ver) that has pages that this IG references, without depending on. The sole purpose of defining these IGs is to inform the publisher link checker that links to this IG are valid

IG Page Name (for R4 or earlier - part of R5)

An implementation guide parameter defined by the HL7 IG Publisher. This is used in R4 IGs where the binding to paramater name prevented the use of additional parameters

Instructs the IG publisher to load a bundle when loading the source, but to treat all the resources found in the bundle as independent resources in the IG (e.g. not a bundle). Use this for bundles of examples

Specifies whether a particular element or resource is expected to have an id or not. Note that this can be done in a profile on the element, but it is sometimes useful to say this e.g. on an abstract element in a logical model

A prefix value that is automatically prefixed to the value before it’s validated (for use in logical models)

Inherit all the obligations from an Obligation Profile

empty-behaviour: what should be in JSON when a repeating elements has no items? Can be absent, present, or either

If an element is labelled nullable, it can be present as a null value in the json. If this extension does not appear, a null value is treated as an error

Marks an element as a choice of types where the type is implied by the JSON type. The only valid types at string, integer, decimal, and boolean

If true, indicates that in a JSON representation, the indicated child element is the json property key for the value. Implies that this is a property with max = * that has two children, one of which is the key and the other is the value

Provides the JSON property name for when the JSON name is not a valid element name, or on the root of a type to give the type itself an element name

This extension is used in logical models to indicate that the type that can be the container of this definition. This can be a reference to an abstract definition, or a particular concrete definition. This is the (base) class encountered when %resource and %rootResource is found in FHIRPath constraint expressions.

This extension is used logical models to indicate that this type can be the target of a reference. This indicates that there is a persistence identity and maintenance lifecycle for the type, though there are no requirements for how those are defined.

Use this extension to indicate tha the element has an XML namespace different to http://hl7.org/fhir. The special value noNamespace indicates that there is no assigned XML namespace.

This extension is used on elements of type code to indicate that it’s deliberate and appropriate that they not have a binding. Typically, this is because they are contained by another type that does have a binding, but there are other reasons. This is provided to assist with QA processes that can use this to be informed where bindings are not necessary or appropriate.

Profiles marked to be ‘Obligation Profiles’ cannot introduce new structural elements or slicing, but they can add additional bindings, and additional obligations on the elements that are already defined

Specifies the Npm Package scope for scoped packages. See how FHIR Packages are scoped for further information

Extension definition for Mapping between API and Profile. CapabilityStatement.rest.resource.profile has two different profile statements:

• profile - the overall system profile for a resource
• supportedProfile 0..* - a particular profile that the system supports

What is missing from this picture is defining which resources conform to which profile. Sometimes, of course, it’s impossible to define this, but quite often, there’s an algorithmic relationship that a server or client could use to know that resources with a particular set of values will or should conform to a given profile.

This extension defines a relationship between a search string and a profile. Any resource that meets a given search string will be expected to conform to the particular profile. If more than one profile is nominated for a search string, resources SHALL conform to all the listed profiles. The last extension can be without a search matches and remaining resources

This extension repeats, and order is important - once a match is found, this profile is the one that applies. Todo: If this extension is useful, it will be moved to the core extensions pack

Defines fragments, possibly with ellipsed content, to generate from a specified resource for a embedding as part of resource pages.

Allows assertion of a sort order for a resource in the list of artifacts within the IG

Indicates the base type for a search parameter when the actual base type is not a valid resource (e.g. custom resource etc)

This extension indicates that in addition to the concepts directly selected (either included or excluded) in the include/exclude statement, any source codes that are mapped to target codes that are selected by the nominated ConceptMapare also selected. The filter property can be used to restrict which types of relationships are included. Todo: If this is useful, it will be moved to the core extensions pack

How the data type is bound to vocabulary

In some logical models, the type of content at one location depends on the value of some other element, and the type is otherwise not explicit in the instance. In such cases, the type of the element is assigned an abstract ancestor type, and this extension specifies how to determine what type is actually used

A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

This extension is for canonical resources to indicate where a human readable web page describing the resource can be found, if it’s at a different location to the canonical URL itself. Todo: This might be considered for moving to the core extensions pack

If true, marks that this element is a choice group that doesn’t literally appear in the XML; it only exists to group a set of repeating of elements

Provides the XML element name for when the XML name is not a valid element name, or on the root of a type to give the type itself an element name

Additional Binding Purpose

CDSActionType Codes

CDSIndicator Codes

CDSLinkType Codes

CDSSelectionBehavior Codes

How the type can be extended. Note that all FHIR types that inherit from Element have extension-style = fhir-extensions

Specifies whether a particular element or resource is expected to have an id or not

empty-behaviour: what should be in JSON when a repeating elements has no items? Can be absent, present, or either

select-by-map filter Codes - from either R4 (or previous) or R5

How the data type is bound to vocabulary

ig-parameters Codes

Additional Binding Purpose

Codes that describe application CDSActionTypes

Codes that describe application CDSIndicators

Codes that describe application CDSLinkTypes

Codes that describe application CDSSelectionBehaviors

The degree of equivalence between concepts (R4).

How the type can be extended. Note that all FHIR types that inherit from Element have extension-style = fhir-extensions

Ig Parameter Codes Defined by the FHIR Tooling. These parameter codes go in ImplementationGuide.definition.parameter.code

Specifies whether a particular element or resource is expected to have an id or not

empty-behaviour: what should be in JSON when a repeating elements has no items. Can be absent, present, or either

Codes that the type of an issue in the response to a $validate-code operation. The validator will handle some types of issues differently. In the absence of an issue type, issues are passed to the user without processing, and this may be confusing to users

How the data type is bound to vocabulary

An example a CDS Hooks Service Request