{
"description": "Explanation of what this profile contains/is for",
"_filename": "StructureDefinition-bundle-uv-livd.json",
"package_name": "hl7.fhir.uv.livd",
"date": "2018-08-14",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - Orders and Observations WG",
"fhirVersion": "3.5.0",
"name": "LIVD Bundle",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern",
"identity": "w5"
} ],
"abstract": false,
"type": "Bundle",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "bdl-7",
"human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId",
"xpath": "count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0",
"source": "Bundle",
"severity": "error",
"expression": "entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()"
}, {
"key": "bdl-9",
"human": "A document must have an identifier with a system and a value",
"xpath": "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)",
"source": "Bundle",
"severity": "error",
"expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())"
}, {
"key": "bdl-3",
"human": "entry.request mandatory for batch/transaction/history, otherwise prohibited",
"xpath": "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')",
"source": "Bundle",
"severity": "error",
"expression": "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))"
}, {
"key": "bdl-4",
"human": "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited",
"xpath": "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')",
"source": "Bundle",
"severity": "error",
"expression": "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))"
}, {
"key": "bdl-12",
"human": "A message must have a MessageHeader as the first resource",
"xpath": "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader",
"source": "Bundle",
"severity": "error",
"expression": "type = 'message' implies entry.first().resource.is(MessageHeader)"
}, {
"key": "bdl-1",
"human": "total only when a search or history",
"xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')",
"source": "Bundle",
"severity": "error",
"expression": "total.empty() or (type = 'searchset') or (type = 'history')"
}, {
"key": "bdl-2",
"human": "entry.search only when a search",
"xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')",
"source": "Bundle",
"severity": "error",
"expression": "entry.search.empty() or (type = 'searchset')"
}, {
"key": "bdl-11",
"human": "A document must have a Composition as the first resource",
"xpath": "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition",
"source": "Bundle",
"severity": "error",
"expression": "type = 'document' implies entry.first().resource.is(Composition)"
}, {
"key": "bdl-10",
"human": "A document must have a date",
"xpath": "not(f:type/@value = 'document') or exists(f:meta/f:lastUpdated/f:value)",
"source": "Bundle",
"severity": "error",
"expression": "type = 'document' implies (meta.lastUpdated.hasValue())"
} ],
"path": "Bundle",
"min": 0,
"definition": "A container for a collection of resources.",
"isModifier": false,
"short": "LIVD Bundle",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "ClinicalDocument, if bundle.type = document",
"identity": "cda"
} ],
"mustSupport": false,
"max": "*",
"id": "Bundle",
"base": {
"max": "*",
"min": 0,
"path": "Bundle"
},
"isSummary": false
}, {
"path": "Bundle.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Bundle.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Bundle.meta",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Bundle.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Bundle.implicitRules",
"min": 0,
"definition": "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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Bundle.implicitRules",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"path": "Bundle.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "Bundle.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"path": "Bundle.identifier",
"min": 1,
"definition": "A persistent identifier for the batch that won't change as a batch is copied from server to server.",
"isModifier": false,
"short": "Persistent identifier for the bundle",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "ClinicalDocument.id",
"identity": "cda"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.identifier",
"comment": "This value must be the same as the Composition.identifier value as there is only on instance of LIVDCatalogProfile in the bundle. It represents the logical identifier for the publication by the vendor.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.identifier"
},
"isSummary": true
}, {
"path": "Bundle.type",
"min": 1,
"definition": "Indicates the purpose of this bundle - how it was intended to be used.",
"isModifier": false,
"short": "collection",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/bundle-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BundleType"
} ],
"description": "Indicates the purpose of a bundle - how it is intended to be used."
},
"max": "1",
"id": "Bundle.type",
"comment": "The bundle represents a collection of resources that make up the LIVD Publication.",
"base": {
"max": "1",
"min": 1,
"path": "Bundle.type"
},
"isSummary": true
}, {
"path": "Bundle.timestamp",
"min": 0,
"definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"isModifier": false,
"short": "When the bundle was assembled",
"mapping": [ {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "ClinicalDocument.effectiveTime",
"identity": "cda"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.timestamp",
"comment": "This element is constrained out as it is more suitable for dynamic query responses than when a publication was created considering that Composition.date already captures that.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.timestamp"
},
"isSummary": true
}, {
"path": "Bundle.total",
"min": 0,
"definition": "If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).",
"isModifier": false,
"short": "If search, the total number of matches",
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.total",
"condition": [ "bdl-1" ],
"comment": "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.total"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Bundle.link",
"min": 0,
"definition": "A series of links that provide context to this bundle.",
"isModifier": false,
"short": "Links related to this Bundle",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.link",
"comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.",
"base": {
"max": "*",
"min": 0,
"path": "Bundle.link"
},
"isSummary": true
}, {
"path": "Bundle.link.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Bundle.link.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Bundle.link.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Bundle.link.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Bundle.link.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Bundle.link.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Bundle.link.relation",
"min": 1,
"definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
"isModifier": false,
"short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.link.relation",
"base": {
"max": "1",
"min": 1,
"path": "Bundle.link.relation"
},
"isSummary": true
}, {
"path": "Bundle.link.url",
"min": 1,
"definition": "The reference details for the link.",
"isModifier": false,
"short": "Reference details for the link",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.link.url",
"base": {
"max": "1",
"min": 1,
"path": "Bundle.link.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "bdl-8",
"human": "fullUrl cannot be a version specific reference",
"xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))",
"source": "Bundle.entry",
"severity": "error",
"expression": "fullUrl.contains('/_history/').not()"
}, {
"key": "bdl-5",
"human": "must be a resource unless there's a request or response",
"xpath": "exists(f:resource) or exists(f:request) or exists(f:response)",
"source": "Bundle.entry",
"severity": "error",
"expression": "resource.exists() or request.exists() or response.exists()"
} ],
"path": "Bundle.entry",
"min": 5,
"definition": "An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).",
"isModifier": false,
"short": "Entry in the bundle - will have a resource, or information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Bundle.entry",
"comment": "The bundles must contain exactly one LIVDCatalogProfile instance, at least one LIVDEntryDefinitionProfile instance, at least one LIVDDeviceDefinitionProfile instance, at least one LIVDConceptMapProfile instance, and at least one LIVDCodeSystemProfile instance.",
"orderMeaning": "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",
"base": {
"max": "*",
"min": 0,
"path": "Bundle.entry"
},
"isSummary": true
}, {
"path": "Bundle.entry.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Bundle.entry.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Bundle.entry.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Bundle.entry.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Bundle.entry.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Bundle.entry.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Bundle.entry.link",
"min": 0,
"definition": "A series of links that provide context to this entry.",
"isModifier": false,
"short": "Links related to this entry",
"contentReference": "#Bundle.link",
"mustSupport": false,
"max": "0",
"id": "Bundle.entry.link",
"base": {
"max": "*",
"min": 0,
"path": "Bundle.entry.link"
},
"isSummary": true
}, {
"path": "Bundle.entry.fullUrl",
"min": 0,
"definition": "The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.",
"isModifier": false,
"short": "Absolute URL for resource (server address, or UUID/OID)",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.entry.fullUrl",
"comment": "fullUrl may 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](references.html), the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then it SHALL end with the Resource.id.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.fullUrl"
},
"isSummary": true
}, {
"path": "Bundle.entry.resource",
"min": 1,
"definition": "The Resources for the entry.",
"isModifier": false,
"short": "A resource in the bundle",
"type": [ {
"code": "Resource"
} ],
"mustSupport": true,
"max": "1",
"id": "Bundle.entry.resource",
"comment": "(LIVDCatalogProfile | LIVDEntryDefinitionProfile | LIVDDeviceDefinitionProfile | LIVDConceptMapProfile | LIVDTestCodeSystemProfile | LIVDLOINCCodeSystemProfile ).",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.resource"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Bundle.entry.search",
"min": 0,
"definition": "Information about the search process that lead to the creation of this entry.",
"isModifier": false,
"short": "Search related information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.entry.search",
"condition": [ "bdl-2" ],
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.search"
},
"isSummary": true
}, {
"path": "Bundle.entry.search.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Bundle.entry.search.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Bundle.entry.search.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Bundle.entry.search.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Bundle.entry.search.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Bundle.entry.search.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Bundle.entry.search.mode",
"min": 0,
"definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement.",
"isModifier": false,
"short": "match | include | outcome - why this is in the result set",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchEntryMode"
} ],
"description": "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."
},
"max": "1",
"id": "Bundle.entry.search.mode",
"comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.search.mode"
},
"isSummary": true
}, {
"path": "Bundle.entry.search.score",
"min": 0,
"definition": "When searching, the server's search ranking score for the entry.",
"isModifier": false,
"short": "Search ranking (between 0 and 1)",
"type": [ {
"code": "decimal"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.search.score",
"comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.search.score"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Bundle.entry.request",
"min": 0,
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"isModifier": false,
"short": "Transaction Related Information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.entry.request",
"condition": [ "bdl-3" ],
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.request"
},
"isSummary": true
}, {
"path": "Bundle.entry.request.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Bundle.entry.request.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Bundle.entry.request.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Bundle.entry.request.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Bundle.entry.request.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Bundle.entry.request.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Bundle.entry.request.method",
"min": 1,
"definition": "The HTTP verb for this entry in either a change history, or a transaction/ transaction response.",
"isModifier": false,
"short": "GET | POST | PUT | DELETE",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/http-verb",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HTTPVerb"
} ],
"description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details."
},
"max": "1",
"id": "Bundle.entry.request.method",
"base": {
"max": "1",
"min": 1,
"path": "Bundle.entry.request.method"
},
"isSummary": true
}, {
"path": "Bundle.entry.request.url",
"min": 1,
"definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
"isModifier": false,
"short": "URL for HTTP equivalent of this entry",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.request.url",
"comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT, and the URL would be \"Patient/[id]\".",
"base": {
"max": "1",
"min": 1,
"path": "Bundle.entry.request.url"
},
"isSummary": true
}, {
"path": "Bundle.entry.request.ifNoneMatch",
"min": 0,
"definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"isModifier": false,
"short": "For managing cache currency",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.request.ifNoneMatch",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifNoneMatch"
},
"isSummary": true
}, {
"path": "Bundle.entry.request.ifModifiedSince",
"min": 0,
"definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"isModifier": false,
"short": "For managing update contention",
"type": [ {
"code": "instant"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.request.ifModifiedSince",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifModifiedSince"
},
"isSummary": true
}, {
"path": "Bundle.entry.request.ifMatch",
"min": 0,
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
"isModifier": false,
"short": "For managing update contention",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.request.ifMatch",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifMatch"
},
"isSummary": true
}, {
"path": "Bundle.entry.request.ifNoneExist",
"min": 0,
"definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"isModifier": false,
"short": "For conditional creates",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.request.ifNoneExist",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifNoneExist"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Bundle.entry.response",
"min": 0,
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"isModifier": false,
"short": "Transaction Related Information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Bundle.entry.response",
"condition": [ "bdl-4" ],
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.response"
},
"isSummary": true
}, {
"path": "Bundle.entry.response.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Bundle.entry.response.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Bundle.entry.response.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Bundle.entry.response.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Bundle.entry.response.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Bundle.entry.response.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Bundle.entry.response.status",
"min": 1,
"definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"isModifier": false,
"short": "Status response code (text optional)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.status",
"base": {
"max": "1",
"min": 1,
"path": "Bundle.entry.response.status"
},
"isSummary": true
}, {
"path": "Bundle.entry.response.location",
"min": 0,
"definition": "The location header created by processing this operation.",
"isModifier": false,
"short": "The location, if the operation returns a location",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.location",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.response.location"
},
"isSummary": true
}, {
"path": "Bundle.entry.response.etag",
"min": 0,
"definition": "The etag for the resource, it the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
"isModifier": false,
"short": "The etag for the resource (if relevant)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.etag",
"comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.response.etag"
},
"isSummary": true
}, {
"path": "Bundle.entry.response.lastModified",
"min": 0,
"definition": "The date/time that the resource was modified on the server.",
"isModifier": false,
"short": "Server's date time modified",
"type": [ {
"code": "instant"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.lastModified",
"comment": "This has to match the same time in the meta header if a resource is included.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.response.lastModified"
},
"isSummary": true
}, {
"path": "Bundle.entry.response.outcome",
"min": 0,
"definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"isModifier": false,
"short": "OperationOutcome with hints and warnings (for batch/transaction)",
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.outcome",
"comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.entry.response.outcome"
},
"isSummary": true
}, {
"path": "Bundle.signature",
"requirements": "This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.",
"min": 0,
"definition": "Digital Signature - base64 encoded. XML-DSIg or a JWT.",
"isModifier": false,
"short": "Digital Signature",
"type": [ {
"code": "Signature"
} ],
"mustSupport": false,
"max": "1",
"id": "Bundle.signature",
"comment": "The signature could be created by the \"author\" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.",
"base": {
"max": "1",
"min": 0,
"path": "Bundle.signature"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "17ed4b7c-f518-48a9-8b6e-ec1d90fb44aa",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/livd/StructureDefinition/bundle-uv-livd",
"version": "0.1.0",
"differential": {
"element": [ {
"id": "Bundle",
"path": "Bundle",
"short": "LIVD Bundle",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
} ],
"isModifier": false,
"mustSupport": false
}, {
"path": "Bundle.identifier",
"min": 1,
"definition": "A persistent identifier for the batch that won't change as a batch is copied from server to server.",
"isModifier": false,
"short": "Persistent identifier for the bundle",
"mustSupport": false,
"max": "1",
"id": "Bundle.identifier",
"comment": "This value must be the same as the Composition.identifier value as there is only on instance of LIVDCatalogProfile in the bundle. It represents the logical identifier for the publication by the vendor."
}, {
"path": "Bundle.type",
"min": 1,
"definition": "Indicates the purpose of this bundle - how it was intended to be used.",
"isModifier": false,
"short": "collection",
"mustSupport": false,
"max": "1",
"id": "Bundle.type",
"comment": "The bundle represents a collection of resources that make up the LIVD Publication."
}, {
"path": "Bundle.timestamp",
"min": 0,
"definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"isModifier": false,
"short": "When the bundle was assembled",
"mustSupport": false,
"max": "0",
"id": "Bundle.timestamp",
"comment": "This element is constrained out as it is more suitable for dynamic query responses than when a publication was created considering that Composition.date already captures that."
}, {
"path": "Bundle.total",
"min": 0,
"definition": "If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).",
"isModifier": false,
"short": "If search, the total number of matches",
"mustSupport": false,
"max": "0",
"id": "Bundle.total",
"comment": "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources."
}, {
"id": "Bundle.link",
"max": "0",
"min": 0,
"path": "Bundle.link",
"short": "Links related to this Bundle",
"definition": "A series of links that provide context to this bundle.",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.link.relation",
"max": "1",
"min": 1,
"path": "Bundle.link.relation",
"short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.link.url",
"max": "1",
"min": 1,
"path": "Bundle.link.url",
"short": "Reference details for the link",
"definition": "The reference details for the link.",
"isModifier": false,
"mustSupport": false
}, {
"path": "Bundle.entry",
"min": 5,
"definition": "An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).",
"isModifier": false,
"short": "Entry in the bundle - will have a resource, or information",
"mustSupport": false,
"max": "*",
"id": "Bundle.entry",
"comment": "The bundles must contain exactly one LIVDCatalogProfile instance, at least one LIVDEntryDefinitionProfile instance, at least one LIVDDeviceDefinitionProfile instance, at least one LIVDConceptMapProfile instance, and at least one LIVDCodeSystemProfile instance."
}, {
"id": "Bundle.entry.link",
"max": "0",
"min": 0,
"path": "Bundle.entry.link",
"short": "Links related to this entry",
"definition": "A series of links that provide context to this entry.",
"isModifier": false,
"mustSupport": false
}, {
"path": "Bundle.entry.fullUrl",
"min": 0,
"definition": "The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.",
"isModifier": false,
"short": "Absolute URL for resource (server address, or UUID/OID)",
"mustSupport": false,
"max": "0",
"id": "Bundle.entry.fullUrl",
"comment": "fullUrl may 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](references.html), the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then it SHALL end with the Resource.id."
}, {
"path": "Bundle.entry.resource",
"min": 1,
"definition": "The Resources for the entry.",
"isModifier": false,
"short": "A resource in the bundle",
"mustSupport": true,
"max": "1",
"id": "Bundle.entry.resource",
"comment": "(LIVDCatalogProfile | LIVDEntryDefinitionProfile | LIVDDeviceDefinitionProfile | LIVDConceptMapProfile | LIVDTestCodeSystemProfile | LIVDLOINCCodeSystemProfile )."
}, {
"id": "Bundle.entry.search",
"max": "0",
"min": 0,
"path": "Bundle.entry.search",
"short": "Search related information",
"definition": "Information about the search process that lead to the creation of this entry.",
"isModifier": false,
"mustSupport": false
}, {
"path": "Bundle.entry.search.mode",
"min": 0,
"definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement.",
"isModifier": false,
"short": "match | include | outcome - why this is in the result set",
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.search.mode",
"comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence."
}, {
"path": "Bundle.entry.search.score",
"min": 0,
"definition": "When searching, the server's search ranking score for the entry.",
"isModifier": false,
"short": "Search ranking (between 0 and 1)",
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.search.score",
"comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order."
}, {
"id": "Bundle.entry.request",
"max": "0",
"min": 0,
"path": "Bundle.entry.request",
"short": "Transaction Related Information",
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.request.method",
"max": "1",
"min": 1,
"path": "Bundle.entry.request.method",
"short": "GET | POST | PUT | DELETE",
"definition": "The HTTP verb for this entry in either a change history, or a transaction/ transaction response.",
"isModifier": false,
"mustSupport": false
}, {
"path": "Bundle.entry.request.url",
"min": 1,
"definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
"isModifier": false,
"short": "URL for HTTP equivalent of this entry",
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.request.url",
"comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT, and the URL would be \"Patient/[id]\"."
}, {
"id": "Bundle.entry.request.ifNoneMatch",
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifNoneMatch",
"short": "For managing cache currency",
"definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.request.ifModifiedSince",
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifModifiedSince",
"short": "For managing update contention",
"definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.request.ifMatch",
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifMatch",
"short": "For managing update contention",
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.request.ifNoneExist",
"max": "1",
"min": 0,
"path": "Bundle.entry.request.ifNoneExist",
"short": "For conditional creates",
"definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.response",
"max": "0",
"min": 0,
"path": "Bundle.entry.response",
"short": "Transaction Related Information",
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.response.status",
"max": "1",
"min": 1,
"path": "Bundle.entry.response.status",
"short": "Status response code (text optional)",
"definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"isModifier": false,
"mustSupport": false
}, {
"id": "Bundle.entry.response.location",
"max": "1",
"min": 0,
"path": "Bundle.entry.response.location",
"short": "The location, if the operation returns a location",
"definition": "The location header created by processing this operation.",
"isModifier": false,
"mustSupport": false
}, {
"path": "Bundle.entry.response.etag",
"min": 0,
"definition": "The etag for the resource, it the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
"isModifier": false,
"short": "The etag for the resource (if relevant)",
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.etag",
"comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included."
}, {
"path": "Bundle.entry.response.lastModified",
"min": 0,
"definition": "The date/time that the resource was modified on the server.",
"isModifier": false,
"short": "Server's date time modified",
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.lastModified",
"comment": "This has to match the same time in the meta header if a resource is included."
}, {
"path": "Bundle.entry.response.outcome",
"min": 0,
"definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"isModifier": false,
"short": "OperationOutcome with hints and warnings (for batch/transaction)",
"mustSupport": false,
"max": "1",
"id": "Bundle.entry.response.outcome",
"comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned."
}, {
"path": "Bundle.signature",
"requirements": "This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.",
"min": 0,
"definition": "Digital Signature - base64 encoded. XML-DSIg or a JWT.",
"isModifier": false,
"short": "Digital Signature",
"mustSupport": false,
"max": "1",
"id": "Bundle.signature",
"comment": "The signature could be created by the \"author\" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/orders/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle"
}