Profiles & Operations Index > Profile: Bundle (Practitioner Response)

Profile: Bundle (Practitioner Response)

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-Bundle

Simplifier project page: PHSD Bundle Practitioner Response

Derived from: Bundle (R4)

Formal Views of Profile Content

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

Differential View

idS Σ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalS Σ I1..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceΣ0..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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ I1..1LocationResponse
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCode0..1codeBindingFixed Value
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
scoreS Σ1..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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ1..1Resource
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCode0..1codeBindingFixed Value
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
scoreS Σ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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ I1..1OperationOutcome
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
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

idS Σ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalS Σ I1..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceΣ0..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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ I1..1LocationResponse
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCode0..1codeBindingFixed Value
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
scoreS Σ1..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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ1..1Resource
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCode0..1codeBindingFixed Value
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
scoreS Σ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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ I1..1OperationOutcome
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
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

idS Σ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalS Σ I1..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceΣ0..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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ I1..1LocationResponse
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCode0..1codeBindingFixed Value
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
scoreS Σ1..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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ1..1Resource
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCode0..1codeBindingFixed Value
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
scoreS Σ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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlS Σ0..1uri
resourceS Σ I1..1OperationOutcome
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeS Σ1..1codeBindingFixed Value
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.id1..
Bundle.meta1..
Bundle.meta.profile1..
Bundle.type..
Bundle.total1..
Bundle.link1..
Bundle.link1..1
Bundle.entry..
Bundle.entry..
Bundle.entry.fullUrl..
Bundle.entry.resourceLocationResponse1..
Bundle.entry.search1..
Bundle.entry.search.extensionExtension..
Bundle.entry.search.extension.value[x]..
Bundle.entry.search.extension.value[x]..
Bundle.entry.search.mode1..
Bundle.entry.search.score1..
Bundle.entry..
Bundle.entry.fullUrl..
Bundle.entry.resource1..
Bundle.entry.search1..
Bundle.entry.search.extensionExtension..
Bundle.entry.search.extension.value[x]..
Bundle.entry.search.extension.value[x]..
Bundle.entry.search.mode1..
Bundle.entry.search.score..
Bundle.entry..1
Bundle.entry.fullUrl..
Bundle.entry.resourceOperationOutcome1..
Bundle.entry.search1..
Bundle.entry.search.mode1..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "8b8cb726-d3e8-4107-a781-ac9c4c7ddac4",
    "meta": {
        "lastUpdated": "2024-07-26T20:52:45.6737518+00:00"
    },
    "text": {
        "status": "empty",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-Bundle",
    "version": "1.0.0",
    "name": "BundlePractitionerMatch",
    "title": "PHSD Bundle Practitioner Response",
    "status": "draft",
    "date": "2024-03-06T15:47:38.7603239+00:00",
    "description": "This is the Bundle profile from PPR for Practitioner Search resposne and Practitioner EMPI Match operation response.",
    "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.id",
                "path": "Bundle.id",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.meta",
                "path": "Bundle.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.meta.profile",
                "path": "Bundle.meta.profile",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "fixedCode": "searchset",
                "mustSupport": true
            },
            {
                "id": "Bundle.total",
                "path": "Bundle.total",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.link",
                "path": "Bundle.link",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "relation"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "Bundle.link:self",
                "path": "Bundle.link",
                "sliceName": "self",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "search.mode"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Result",
                "path": "Bundle.entry",
                "sliceName": "entry-Result",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Result.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Result.resource",
                "path": "Bundle.entry.resource",
                "definition": "The Resources for the entry-result are PractitionerRole,Practitioner,Location",
                "min": 1,
                "type":  [
                    {
                        "code": "Resource",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-location-response-profile-Location"
                        ]
                    }
                ]
            },
            {
                "id": "Bundle.entry:entry-Result.search",
                "path": "Bundle.entry.search",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Result.search.extension:match-grade",
                "path": "Bundle.entry.search.extension",
                "sliceName": "match-grade",
                "definition": "**PPR Usage:**  This extension will only be used in the Practitioner Match operation, and will use fixed value \"possible\".",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/match-grade"
                        ]
                    }
                ]
            },
            {
                "id": "Bundle.entry:entry-Result.search.extension:match-grade.value[x]",
                "path": "Bundle.entry.search.extension.value[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "Bundle.entry:entry-Result.search.extension:match-grade.value[x]:valueCode",
                "path": "Bundle.entry.search.extension.value[x]",
                "sliceName": "valueCode",
                "fixedCode": "possible"
            },
            {
                "id": "Bundle.entry:entry-Result.search.mode",
                "path": "Bundle.entry.search.mode",
                "min": 1,
                "fixedCode": "match",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Result.search.score",
                "path": "Bundle.entry.search.score",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Include",
                "path": "Bundle.entry",
                "sliceName": "entry-Include",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Include.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Include.resource",
                "path": "Bundle.entry.resource",
                "definition": "The Resources for the entry-result are PractitionerRole,Practitioner,Location",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Include.search",
                "path": "Bundle.entry.search",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Include.search.extension:match-grade",
                "path": "Bundle.entry.search.extension",
                "sliceName": "match-grade",
                "definition": "**PPR Usage:**  This extension will only be used in the Practitioner Match operation, and will use fixed value \"possible\".",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/match-grade"
                        ]
                    }
                ]
            },
            {
                "id": "Bundle.entry:entry-Include.search.extension:match-grade.value[x]",
                "path": "Bundle.entry.search.extension.value[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "Bundle.entry:entry-Include.search.extension:match-grade.value[x]:valueCode",
                "path": "Bundle.entry.search.extension.value[x]",
                "sliceName": "valueCode",
                "fixedCode": "possible"
            },
            {
                "id": "Bundle.entry:entry-Include.search.mode",
                "path": "Bundle.entry.search.mode",
                "min": 1,
                "fixedCode": "include",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-Include.search.score",
                "path": "Bundle.entry.search.score",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-warning",
                "path": "Bundle.entry",
                "sliceName": "entry-warning",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-warning.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-warning.resource",
                "path": "Bundle.entry.resource",
                "min": 1,
                "type":  [
                    {
                        "code": "Resource",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-profile-OperationOutcome"
                        ]
                    }
                ]
            },
            {
                "id": "Bundle.entry:entry-warning.search",
                "path": "Bundle.entry.search",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry:entry-warning.search.mode",
                "path": "Bundle.entry.search.mode",
                "min": 1,
                "fixedCode": "outcome",
                "mustSupport": true
            }
        ]
    }
}

Usage

The Bundle Resource is returned when using the Search Practitioner and Search HealthcareService restful operation.

Notes

.id

  • Definition: Logical id of this artifact
  • used to uniquely identify the resource on this server; may change on other servers

.meta.profile

  • this must be populated with the value http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-Bundle|1.0.0