Profile: SetContextTransactionResponseBundle

Canonical URL: http://fhir.infoway-inforoute.ca/io/HALO/StructureDefinition/set-context-transaction-response-bundle

Simplifier project page: SetContextTransactionResponseBundle

Derived from: Bundle (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ1..1uri
resourceΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ1..1uri
etagΣ1..1string
lastModifiedΣ1..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ1..1uri
resourceΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ1..1uri
etagΣ1..1string
lastModifiedΣ1..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ1..1uri
resourceΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ1..1uri
etagΣ1..1string
lastModifiedΣ1..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
Bundle..
Bundle.type..
Bundle.entry..
Bundle.entry.fullUrl1..
Bundle.entry.response..
Bundle.entry.response.location1..
Bundle.entry.response.etag1..
Bundle.entry.response.lastModified1..

{
"resourceType": "StructureDefinition",
"id": "set-context-transaction-response-bundle",
"text": {
"status": "additional",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://fhir.infoway-inforoute.ca/io/HALO/StructureDefinition/set-context-transaction-response-bundle",
"name": "SetContextTransactionResponseBundle",
"status": "draft",
"description": "A Bundle profile which communicates the outcome of the create interaction on the SoFA for each resource included in the input transaction Bundle of the $set-context operation.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"element": [
{
"id": "Bundle.type",
"path": "Bundle.type",
"fixedCode": "transaction-response"
},
{
"id": "Bundle.entry.fullUrl",
"path": "Bundle.entry.fullUrl",
"min": 1
},
{
"id": "Bundle.entry.response.location",
"path": "Bundle.entry.response.location",
"min": 1
},
{
"id": "Bundle.entry.response.etag",
"path": "Bundle.entry.response.etag",
"min": 1
},
{
"id": "Bundle.entry.response.lastModified",
"path": "Bundle.entry.response.lastModified",
"min": 1
}
]
}
}
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="set-context-transaction-response-bundle" />
<status value="additional" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="http://fhir.infoway-inforoute.ca/io/HALO/StructureDefinition/set-context-transaction-response-bundle" />
<name value="SetContextTransactionResponseBundle" />
<status value="draft" />
<description value="A Bundle profile which communicates the outcome of the create interaction on the SoFA for each resource included in the input transaction Bundle of the $set-context operation." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<element id="Bundle.type">
<path value="Bundle.type" />
<fixedCode value="transaction-response" />
</element>
<element id="Bundle.entry.fullUrl">
<path value="Bundle.entry.fullUrl" />
<min value="1" />
</element>
<element id="Bundle.entry.response.location">
<path value="Bundle.entry.response.location" />
<min value="1" />
</element>
<element id="Bundle.entry.response.etag">
<path value="Bundle.entry.response.etag" />
<min value="1" />
</element>
<element id="Bundle.entry.response.lastModified">
<path value="Bundle.entry.response.lastModified" />
<min value="1" />
</element>
</differential>
</StructureDefinition>

Usage

This profile defines constraints on the FHIR Bundle resource used in the resourcesResponse output parameter of the $set-context operation response. The Bundle SHALL be of type transaction-response and SHALL communicate the results of the transaction executed in response to the SetContextTransactionBundle submitted during the operation invocation. Systems receiving and processing the input transaction Bundle SHALL return this Bundle in the response to detail the outcomes of the transaction, including resource creations, updates, or failures. Point of Care (PoC) systems writing resources to the SoFA via the $set-context operation, SHOULD store a mapping between the local IDs of the resources submitted and the resource IDs returned in this Bundle. This mapping is not only recommended for traceability purposes, but also to enable PoC systems to reconcile resource updates received through the HALO Subscription mechanism post-launch.

For additional details on the role of the resourcesResponse output parameter and its usage within the $set-context operation, see the Operation: $set-context page.