Left: | Bundle - IPS (http://hl7.org/fhir/uv/ips/StructureDefinition/Bundle-uv-ips) |
Right: | Bundle - IPS (http://hl7.org/fhir/uv/ips/StructureDefinition/Bundle-uv-ips) |
Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '2.0.0-ballot' |
Information | StructureDefinition.date | Values for date differ: '2022-11-22T03:24:39+00:00' vs '2024-06-19T10:50:07-05:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'Health Level Seven International - Patient Care Work Group' vs 'HL7 International / Patient Care' |
Information | Bundle.link | Element maximum cardinalities differ: '0' vs '2147483647' |
Information | StructureDefinition.comment | Values for comment differ: 'Must contain the IPS Composition as the first entry (only a single Composition resource instance may be included). Additional constraints are specified in the IPS Composition profile.' vs 'Must contain the IPS Composition as the first entry (only a single Composition resource instance may be included) and a Patient resource. Additional constraints are specified in the IPS Composition profile.' |
Information | Bundle.entry | Element minimum cardinalities differ: '1' vs '2' |
Information | StructureDefinition.comment | Values for comment differ: 'fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R4/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R4/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).' vs 'fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R4/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Bundle | ||
copyright | |||
date | 2022-11-22T03:24:39+00:00 | 2024-06-19T10:50:07-05:00 |
|
description | This profile represents the constraints applied to the Bundle resource by the International Patient Summary (IPS) FHIR Implementation Guide. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
kind | resource | ||
name | BundleUvIps | ||
publisher | Health Level Seven International - Patient Care Work Group | HL7 International / Patient Care |
|
purpose | An International Patient Summary (IPS) bundle is an electronic health record extract containing essential healthcare information about a subject of care, comprising at least the required elements of the IPS dataset. The IPS dataset is minimal and non-exhaustive; specialty-agnostic and condition-independent; but still clinically relevant. As specified in EN 17269 and ISO 27269, it is designed for supporting the use case scenario for ‘unplanned, cross border care’, but it is not limited to it. It is intended to be international, i.e., to provide generic solutions for global application beyond a particular region or country. | ||
status | active | ||
title | Bundle - IPS | ||
type | Bundle | ||
url | http://hl7.org/fhir/uv/ips/StructureDefinition/Bundle-uv-ips | ||
version | 1.1.0 | 2.0.0-ballot |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Bundle | International Patient Summary Bundle bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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-ips-1: An IPS document must have no additional Composition (including Composition subclass) resources besides the first. | C | 0..* | Bundle | International Patient Summary Bundle bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited 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-ips-1: An IPS document must have no additional Composition (including Composition subclass) resources besides the first. | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
identifier | SΣ | 1..1 | Identifier | Persistent identifier for the bundle | SΣ | 1..1 | Identifier | Persistent identifier for the bundle | |||||||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document | |||||||||
timestamp | SΣ | 1..1 | instant | When the bundle was assembled | SΣ | 1..1 | instant | When the bundle was assembled | |||||||||
total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ΣC | 0..1 | unsignedInt | If search, the total number of matches | |||||||||
link | Σ | 0..0 | Σ | 0..* | BackboneElement | Links related to this Bundle |
| ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |||||||||
url | Σ | 1..1 | uri | Reference details for the link | Σ | 1..1 | uri | Reference details for the link | |||||||||
Slices for entry | SΣC | 1..* | BackboneElement | Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, 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 | SΣC | 2..* | BackboneElement | Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, 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 |
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | Σ | 0..* | See link (Bundle) | Links related to this entry | |||||||||
fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||||||
resource | Σ | 0..1 | Resource | A resource in the bundle | Σ | 0..1 | Resource | A resource in the bundle | |||||||||
search | ΣC | 0..0 | ΣC | 0..0 | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: ?? (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. | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: ?? (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) | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | |||||||||
request | ΣC | 0..0 | ΣC | 0..0 | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | |||||||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | Σ | 0..1 | string | For managing cache currency | |||||||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | Σ | 0..1 | instant | For managing cache currency | |||||||||
ifMatch | Σ | 0..1 | string | For managing update contention | Σ | 0..1 | string | For managing update contention | |||||||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | Σ | 0..1 | string | For conditional creates | |||||||||
response | ΣC | 0..0 | ΣC | 0..0 | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
status | Σ | 1..1 | string | Status response code (text optional) | Σ | 1..1 | string | Status response code (text optional) | |||||||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | Σ | 0..1 | uri | The location (if the operation returns a location) | |||||||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | Σ | 0..1 | string | The Etag for the resource (if relevant) | |||||||||
lastModified | Σ | 0..1 | instant | Server's date time modified | Σ | 0..1 | instant | Server's date time modified | |||||||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||||||
signature | ΣTU | 0..1 | Signature | Digital Signature | Σ | 0..1 | Signature | Digital Signature | |||||||||
Documentation for this format |