A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

An Extension

STU3: GuidanceResponse.module additional types (Reference(http://hl7.org/fhir/StructureDefinition/ServiceDefinition)) additional types from child elements (display, identifier, reference)

Element GuidanceResponse.module is mapped to FHIR R4B element GuidanceResponse.module[x] as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.module do not cover the following types: Reference. The mappings for GuidanceResponse.module do not cover the following types based on type expansion: display, identifier, reference. The target context GuidanceResponse.module[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element GuidanceResponse.

STU3: GuidanceResponse.reason[x] additional types from child elements (display, identifier, reference)

Element GuidanceResponse.reason[x] is mapped to FHIR R4B element GuidanceResponse.reasonCode as RelatedTo. Element GuidanceResponse.reason[x] is mapped to FHIR R4B element GuidanceResponse.reasonReference as RelatedTo. The mappings for GuidanceResponse.reason[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.reason[x] with unmapped reference targets: Resource.

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

An identifier, CodeableConcept or canonical reference to the guidance that was requested.

The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

The status of a guidance response.

STU3: GuidanceResponse.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

Element GuidanceResponse.meta is mapped to FHIR R4B element GuidanceResponse.meta as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.meta do not cover the following types: Meta. The mappings for GuidanceResponse.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

STU3: GuidanceResponse.text additional types (Narrative) additional types from child elements (div, status)

Element GuidanceResponse.text is mapped to FHIR R4B element GuidanceResponse.text as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.text do not cover the following types: Narrative. The mappings for GuidanceResponse.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

STU3: GuidanceResponse.module additional types (Reference(http://hl7.org/fhir/StructureDefinition/ServiceDefinition)) additional types from child elements (display, identifier, reference)

Element GuidanceResponse.module is mapped to FHIR R4B element GuidanceResponse.module[x] as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.module do not cover the following types: Reference. The mappings for GuidanceResponse.module do not cover the following types based on type expansion: display, identifier, reference. The target context GuidanceResponse.module[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element GuidanceResponse.

STU3: GuidanceResponse.reason[x] additional types from child elements (display, identifier, reference)

Element GuidanceResponse.reason[x] is mapped to FHIR R4B element GuidanceResponse.reasonCode as RelatedTo. Element GuidanceResponse.reason[x] is mapped to FHIR R4B element GuidanceResponse.reasonReference as RelatedTo. The mappings for GuidanceResponse.reason[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.reason[x] with unmapped reference targets: Resource.

STU3: GuidanceResponse.requestId additional types (id) additional types from child elements (value)

Element GuidanceResponse.requestId is mapped to FHIR R4B element GuidanceResponse.requestIdentifier as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.requestId do not cover the following types: id. The mappings for GuidanceResponse.requestId do not cover the following types based on type expansion: value.

STU3: GuidanceResponse.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

Element GuidanceResponse.identifier is mapped to FHIR R4B element GuidanceResponse.identifier as RelatedTo. The mappings for GuidanceResponse.identifier do not cover the following types: Identifier. The mappings for GuidanceResponse.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

STU3: GuidanceResponse.subject additional types from child elements (display, identifier, reference)

Element GuidanceResponse.subject is mapped to FHIR R4B element GuidanceResponse.subject as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.subject do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.subject with unmapped reference targets: Group, Patient.

STU3: GuidanceResponse.context additional types from child elements (display, identifier, reference)

Element GuidanceResponse.context is mapped to FHIR R4B element GuidanceResponse.encounter as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.context do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.context with unmapped reference targets: Encounter, EpisodeOfCare.

STU3: GuidanceResponse.performer additional types from child elements (display, identifier, reference)

Element GuidanceResponse.performer is mapped to FHIR R4B element GuidanceResponse.performer as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.performer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.performer with unmapped reference targets: Device.

STU3: GuidanceResponse.note additional types (Annotation) additional types from child elements (author[x], text, time)

Element GuidanceResponse.note is mapped to FHIR R4B element GuidanceResponse.note as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.note do not cover the following types: Annotation. The mappings for GuidanceResponse.note do not cover the following types based on type expansion: author[x], text, time.

STU3: GuidanceResponse.evaluationMessage additional types from child elements (display, identifier, reference)

Element GuidanceResponse.evaluationMessage is mapped to FHIR R4B element GuidanceResponse.evaluationMessage as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.evaluationMessage do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.evaluationMessage with unmapped reference targets: OperationOutcome.

STU3: GuidanceResponse.outputParameters additional types from child elements (display, identifier, reference)

Element GuidanceResponse.outputParameters is mapped to FHIR R4B element GuidanceResponse.outputParameters as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.outputParameters do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.outputParameters with unmapped reference targets: Parameters.

STU3: GuidanceResponse.result additional types from child elements (display, identifier, reference)

Element GuidanceResponse.result is mapped to FHIR R4B element GuidanceResponse.result as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.result do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.result with unmapped reference targets: CarePlan, RequestGroup.

STU3: GuidanceResponse.dataRequirement additional types (DataRequirement) additional types from child elements (codeFilter, path, valueCode, valueCodeableConcept, valueCoding, valueSet[x], dateFilter, value[x], mustSupport, profile, type)

Element GuidanceResponse.dataRequirement is mapped to FHIR R4B element GuidanceResponse.dataRequirement as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.dataRequirement do not cover the following types: DataRequirement. The mappings for GuidanceResponse.dataRequirement do not cover the following types based on type expansion: codeFilter, dateFilter, mustSupport, path, profile, type, value[x], valueCode, valueCodeableConcept, valueCoding, valueSet[x].

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

Element GuidanceResponse.meta is mapped to FHIR R4B element GuidanceResponse.meta as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.meta do not cover the following types: Meta. The mappings for GuidanceResponse.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

When the resource last changed - e.g. when the version changed.

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

IETF language tag

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.text additional types (Narrative) additional types from child elements (div, status)

Element GuidanceResponse.text is mapped to FHIR R4B element GuidanceResponse.text as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.text do not cover the following types: Narrative. The mappings for GuidanceResponse.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

The actual narrative content, a stripped down version of XHTML.

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

An Extension

STU3: GuidanceResponse.module additional types (Reference(http://hl7.org/fhir/StructureDefinition/ServiceDefinition)) additional types from child elements (display, identifier, reference)

Element GuidanceResponse.module is mapped to FHIR R4B element GuidanceResponse.module[x] as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.module do not cover the following types: Reference. The mappings for GuidanceResponse.module do not cover the following types based on type expansion: display, identifier, reference. The target context GuidanceResponse.module[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element GuidanceResponse.

STU3: GuidanceResponse.reason[x] additional types from child elements (display, identifier, reference)

Element GuidanceResponse.reason[x] is mapped to FHIR R4B element GuidanceResponse.reasonCode as RelatedTo. Element GuidanceResponse.reason[x] is mapped to FHIR R4B element GuidanceResponse.reasonReference as RelatedTo. The mappings for GuidanceResponse.reason[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.reason[x] with unmapped reference targets: Resource.

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.requestId additional types (id) additional types from child elements (value)

Element GuidanceResponse.requestId is mapped to FHIR R4B element GuidanceResponse.requestIdentifier as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.requestId do not cover the following types: id. The mappings for GuidanceResponse.requestId do not cover the following types based on type expansion: value.

The purpose of this identifier.

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Allows users to make use of identifiers when the identifier system is not known.

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Identifier.system is always case sensitive.

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Time period during which identifier is/was valid for use.

Organization that issued/manages the identifier.

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Allows a service to provide unique, business identifiers for the response.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

Element GuidanceResponse.identifier is mapped to FHIR R4B element GuidanceResponse.identifier as RelatedTo. The mappings for GuidanceResponse.identifier do not cover the following types: Identifier. The mappings for GuidanceResponse.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

The purpose of this identifier.

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Allows users to make use of identifiers when the identifier system is not known.

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Identifier.system is always case sensitive.

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Time period during which identifier is/was valid for use.

Organization that issued/manages the identifier.

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

An identifier, CodeableConcept or canonical reference to the guidance that was requested.

The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

The status of a guidance response.

The patient for which the request was processed.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.subject additional types from child elements (display, identifier, reference)

Element GuidanceResponse.subject is mapped to FHIR R4B element GuidanceResponse.subject as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.subject do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.subject with unmapped reference targets: Group, Patient.

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Plain text narrative that identifies the resource in addition to the resource reference.

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

The encounter during which this response was created or to which the creation of this record is tightly associated.

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.context additional types from child elements (display, identifier, reference)

Element GuidanceResponse.context is mapped to FHIR R4B element GuidanceResponse.encounter as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.context do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.context with unmapped reference targets: Encounter, EpisodeOfCare.

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Plain text narrative that identifies the resource in addition to the resource reference.

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Indicates when the guidance response was processed.

Provides a reference to the device that performed the guidance.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.performer additional types from child elements (display, identifier, reference)

Element GuidanceResponse.performer is mapped to FHIR R4B element GuidanceResponse.performer as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.performer do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.performer with unmapped reference targets: Device.

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Plain text narrative that identifies the resource in addition to the resource reference.

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Describes the reason for the guidance response in coded or textual form.

Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

Provides a mechanism to communicate additional information about the response.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.note additional types (Annotation) additional types from child elements (author[x], text, time)

Element GuidanceResponse.note is mapped to FHIR R4B element GuidanceResponse.note as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.note do not cover the following types: Annotation. The mappings for GuidanceResponse.note do not cover the following types based on type expansion: author[x], text, time.

The individual responsible for making the annotation.

Organization is used when there's no need for specific attribution as to who made the comment.

Indicates when this particular annotation was made.

The text of the annotation in markdown format.

Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.evaluationMessage additional types from child elements (display, identifier, reference)

Element GuidanceResponse.evaluationMessage is mapped to FHIR R4B element GuidanceResponse.evaluationMessage as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.evaluationMessage do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.evaluationMessage with unmapped reference targets: OperationOutcome.

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Plain text narrative that identifies the resource in addition to the resource reference.

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.outputParameters additional types from child elements (display, identifier, reference)

Element GuidanceResponse.outputParameters is mapped to FHIR R4B element GuidanceResponse.outputParameters as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.outputParameters do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.outputParameters with unmapped reference targets: Parameters.

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Plain text narrative that identifies the resource in addition to the resource reference.

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

The actions, if any, produced by the evaluation of the artifact.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.result additional types from child elements (display, identifier, reference)

Element GuidanceResponse.result is mapped to FHIR R4B element GuidanceResponse.result as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.result do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element GuidanceResponse.result with unmapped reference targets: CarePlan, RequestGroup.

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Plain text narrative that identifies the resource in addition to the resource reference.

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: GuidanceResponse.dataRequirement additional types (DataRequirement) additional types from child elements (codeFilter, path, valueCode, valueCodeableConcept, valueCoding, valueSet[x], dateFilter, value[x], mustSupport, profile, type)

Element GuidanceResponse.dataRequirement is mapped to FHIR R4B element GuidanceResponse.dataRequirement as SourceIsBroaderThanTarget. The mappings for GuidanceResponse.dataRequirement do not cover the following types: DataRequirement. The mappings for GuidanceResponse.dataRequirement do not cover the following types based on type expansion: codeFilter, dateFilter, mustSupport, path, profile, type, value[x], valueCode, valueCodeableConcept, valueCoding, valueSet[x].

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

The profile of the required data, specified as the uri of the profile definition.

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

Specifies a maximum number of results that are required (uses the _count search parameter).

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Enables the requirement "most recent 5 results" to be expressed.

Specifies the order of the results to be returned.

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Enables the requirement "most recent 5 results" to be expressed.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.