Profiles & Operations > Profile: Bundle

Profile: Bundle

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle

Simplifier project page: Bundle

Derived from: Bundle (R4)

Formal Views of Profile Content

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

Differential View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
typeS Σ1..1codeBindingFixed Value
timestampS Σ1..1instant
totalΣ I0..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ1..1uri
resourceS Σ1..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Hybrid View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
typeS Σ1..1codeBindingFixed Value
timestampS Σ1..1instant
totalΣ I0..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ1..1uri
resourceS Σ1..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Snapshot View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
typeS Σ1..1codeBindingFixed Value
timestampS Σ1..1instant
totalΣ I0..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ1..1uri
resourceS Σ1..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Table View

Bundle..
Bundle.meta1..
Bundle.meta.profile1..
Bundle.meta.security..1
Bundle.meta.security.system..
Bundle.meta.security.code..
Bundle.meta.tag1..1
Bundle.meta.tag.system1..
Bundle.meta.tag.code1..
Bundle.identifier1..
Bundle.identifier.system1..
Bundle.identifier.value1..
Bundle.type..
Bundle.timestamp1..
Bundle.entry1..
Bundle.entry.fullUrl1..
Bundle.entry.resource1..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-seris-profile-Bundle",
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle",
    "version": "1.0.0",
    "name": "Bundle",
    "title": "Bundle",
    "status": "draft",
    "date": "2023-03-10",
    "publisher": "Ontario Health",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://ontariohealth.ca/fhir/"
                },
                {
                    "system": "email",
                    "value": "some.email@ontariohealth.ca"
                }
            ]
        }
    ],
    "description": "Constraints on Bundle resource ensuring that message is defined.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "cda",
            "uri": "http://hl7.org/v3/cda",
            "name": "CDA (R2)"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Bundle",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Bundle.meta",
                "path": "Bundle.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.profile",
                "path": "Bundle.meta.profile",
                "comment": "#### **_` FOR SERIS USAGE: The meta.profile = http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.security",
                "path": "Bundle.meta.security",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.security.system",
                "path": "Bundle.meta.security.system",
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.security.code",
                "path": "Bundle.meta.security.code",
                "fixedCode": "HTEST",
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.tag",
                "path": "Bundle.meta.tag",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.tag.system",
                "path": "Bundle.meta.tag.system",
                "min": 1,
                "fixedUri": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-health-care-facility-id",
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.tag.code",
                "path": "Bundle.meta.tag.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.identifier",
                "path": "Bundle.identifier",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.identifier.system",
                "path": "Bundle.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.identifier.value",
                "path": "Bundle.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "fixedCode": "message",
                "mustSupport": true
            },
            {
                "id": "Bundle.timestamp",
                "path": "Bundle.timestamp",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.resource",
                "path": "Bundle.entry.resource",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ca-on-seris-profile-Bundle" />
    <url value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle" />
    <version value="1.0.0" />
    <name value="Bundle" />
    <title value="Bundle" />
    <status value="draft" />
    <date value="2023-03-10" />
    <publisher value="Ontario Health" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://ontariohealth.ca/fhir/" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="some.email@ontariohealth.ca" />
        </telecom>
    </contact>
    <description value="Constraints on Bundle resource ensuring that message is defined." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="cda" />
        <uri value="http://hl7.org/v3/cda" />
        <name value="CDA (R2)" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Bundle" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
    <derivation value="constraint" />
    <differential>
        <element id="Bundle.meta">
            <path value="Bundle.meta" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.profile">
            <path value="Bundle.meta.profile" />
            <comment value="#### **_` FOR SERIS USAGE: The meta.profile = http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.security">
            <path value="Bundle.meta.security" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.security.system">
            <path value="Bundle.meta.security.system" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/v3-ActReason" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.security.code">
            <path value="Bundle.meta.security.code" />
            <fixedCode value="HTEST" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.tag">
            <path value="Bundle.meta.tag" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.tag.system">
            <path value="Bundle.meta.tag.system" />
            <min value="1" />
            <fixedUri value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-health-care-facility-id" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.meta.tag.code">
            <path value="Bundle.meta.tag.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.identifier">
            <path value="Bundle.identifier" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.identifier.system">
            <path value="Bundle.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.identifier.value">
            <path value="Bundle.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.type">
            <path value="Bundle.type" />
            <fixedCode value="message" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.timestamp">
            <path value="Bundle.timestamp" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.entry">
            <path value="Bundle.entry" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.entry.fullUrl">
            <path value="Bundle.entry.fullUrl" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Bundle.entry.resource">
            <path value="Bundle.entry.resource" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

Usage

The Bundle resource is used to create the packaged payload for the submission of an OR Case. Each bundle shall represent a single OR Case only. During the bundle creation for a new OR Case, the Source System shall use a unique Bundle identifier. Any subsequent updates to that OR Case will require the same Bundle identifier during the creation of that resource.

Notes

.id

  • used to uniquely identify the resource

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Bundle-case

.meta.security

  • Note: 'HTEST' should only be leveraged for test/conformance payloads.

.type

  • fix to collection

.identifier

  • Bundle message identifier

.entry

  • the resources contained in the bundle

.entry.fullUrl

  • the full URL of the resource

.entry:Header

  • the MessageHeader resource that identifies the focal point of the message