Clinical Practice Guidelines (CPG) on EBMonFHIR
1.0.2 - qa-preview
This page is part of the CPG-on-EBMonFHIR Implementation Guide (1.0.2).
Defining URL: | https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/guideline-bundle |
Version: | 0.2.0 |
Name: | GuidelineBundle |
Title: | Guideline Bundle |
Status: | Draft as of 2022-12-08 |
Definition: | Collection of all resources that represent a single clinical practice guideline. |
Publisher: | Netzwerk Universitätsmedizin (NUM), |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/guideline-bundle
This bundle is used to collect all resources of a specific clinical practice guideline. It contains the following resources:
This profile of a FHIR Bundle is derived from the Bundle FHIR resource.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
identifier | ΣC | 0..1 | Identifier | Persistent identifier for the bundle | ||||
type | ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection | ||||
timestamp | ΣC | 0..1 | instant | When the bundle was assembled | ||||
total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
link | ΣC | 0..* | BackboneElement | Links related to this Bundle | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relation | ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
url | ΣC | 1..1 | uri | Reference details for the link | ||||
Slices for entry | SΣC | 6..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
entry:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | SΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | SΣC | 1..1 | Resource | A resource in the bundle | ||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:guideline | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | Guideline | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:guidelineCitation | SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | GuidelineCitation | A description of identification, location, or contributorship of a publication (article or artifact) | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:recommendation | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | Recommendation | The definition of a plan for a series of actions, independent of any specific patient or context | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:recommendationPlan | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | RecommendationPlan | The definition of a plan for a series of actions, independent of any specific patient or context | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:recommendationAction | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | RecommendationAction | The definition of a specific activity to be taken, independent of any particular patient or context | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:PICOEvidenceVariable | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | PICOEvidenceVariable | A definition of an exposure, outcome, or other variable | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:recommendationJustification | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | RecommendationJustification | Adds metadata-supported comments, classifiers or ratings related to a Resource | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:certaintyOfEvidenceRating | SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | CertaintyOfEvidenceRating | Adds metadata-supported comments, classifiers or ratings related to a Resource | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:outcomeEvidence | SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | OutcomeEvidence | Single evidence bit | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:studyCitation | SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | StudyCitation | A description of identification, location, or contributorship of a publication (article or artifact) | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:recommendationCitation | SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | RecommendationCitation | A description of identification, location, or contributorship of a publication (article or artifact) | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
entry:netEffect | SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
resource | 0..1 | NetEffectEstimate | Single evidence bit | |||||
search | ΣC | 0..1 | BackboneElement | Search related information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | Σ | 0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | Σ | 1..1 | string | Status response code (text optional) | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
signature | Σ | 0..1 | Signature | Digital Signature | ||||
issues | ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | Bundle | Contains a collection of resources | |
meta | Σ | 1..1 | Meta | Metadata about the resource |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
Slices for entry | ΣC | 6..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:All Slices | Content/Rules for all slices | |||
fullUrl | ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | ΣC | 1..1 | Resource | A resource in the bundle |
entry:guideline | ΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:guidelineCitation | ΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:recommendation | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:recommendationPlan | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:recommendationAction | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:PICOEvidenceVariable | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:recommendationJustification | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:certaintyOfEvidenceRating | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:outcomeEvidence | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:studyCitation | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:recommendationCitation | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:netEffect | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
Documentation for this format |
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources bdl-1: First element of Bundle must be an Composition. |
meta | S | 1..1 | Meta | Metadata about the resource |
source | S | 0..1 | uri | Identifies where the resource comes from |
profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Required Pattern: collection | |
Slices for entry | S | 6..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource |
entry:All Slices | Content/Rules for all slices | |||
fullUrl | S | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
resource | S | 1..1 | Resource | A resource in the bundle |
entry:guideline | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | Guideline | A set of resources composed into a single coherent clinical statement with clinical attestation | |
entry:guidelineCitation | S | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | GuidelineCitation | A description of identification, location, or contributorship of a publication (article or artifact) | |
entry:recommendation | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | Recommendation | The definition of a plan for a series of actions, independent of any specific patient or context | |
entry:recommendationPlan | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | RecommendationPlan | The definition of a plan for a series of actions, independent of any specific patient or context | |
entry:recommendationAction | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | RecommendationAction | The definition of a specific activity to be taken, independent of any particular patient or context | |
entry:PICOEvidenceVariable | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | PICOEvidenceVariable | A definition of an exposure, outcome, or other variable | |
entry:recommendationJustification | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | RecommendationJustification | Adds metadata-supported comments, classifiers or ratings related to a Resource | |
entry:certaintyOfEvidenceRating | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | CertaintyOfEvidenceRating | Adds metadata-supported comments, classifiers or ratings related to a Resource | |
entry:outcomeEvidence | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | OutcomeEvidence | Single evidence bit | |
entry:studyCitation | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | StudyCitation | A description of identification, location, or contributorship of a publication (article or artifact) | |
entry:recommendationCitation | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | RecommendationCitation | A description of identification, location, or contributorship of a publication (article or artifact) | |
entry:netEffect | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
resource | 0..1 | NetEffectEstimate | Single evidence bit | |
Documentation for this format |
This structure is derived from Bundle
Summary
Mandatory: 10 elements
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code | URI |
Bundle.meta.security | extensible | AllSecurityLabelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Bundle.type | required | Pattern: collectionhttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 from the FHIR Standard | |
Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 from the FHIR Standard | |
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:guideline.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:guideline.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:guidelineCitation.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:guidelineCitation.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendation.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendation.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationPlan.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationPlan.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationAction.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationAction.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:PICOEvidenceVariable.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:PICOEvidenceVariable.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationJustification.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationJustification.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:certaintyOfEvidenceRating.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:certaintyOfEvidenceRating.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:outcomeEvidence.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:outcomeEvidence.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:studyCitation.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:studyCitation.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationCitation.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:recommendationCitation.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard | |
Bundle.entry:netEffect.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 from the FHIR Standard | |
Bundle.entry:netEffect.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 from the FHIR Standard |