Profiles & Operations > Structure Definition: Bundle (Search Result) Profile

Profile: Bundle (Search Result)

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

Simplifier project page: SearchResultBundle

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)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ I1..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceS Σ0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ1..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)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ I1..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceS Σ0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ1..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)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampΣ0..1instant
totalΣ I1..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceS Σ0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ1..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.type..
Bundle.total1..
Bundle.link..
Bundle.entry..
Bundle.entry.resource..
Bundle.entry.search1..
Bundle.entry.search.mode1..

JSON View

{
    "resourceType": "StructureDefinition",
    "meta": {
        "lastUpdated": "2024-05-02T20:54:35.5999579+00:00"
    },
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mi-profile-searchset-Bundle",
    "version": "0.9.0",
    "name": "SearchResultBundle",
    "status": "active",
    "date": "2024-05-02T20:59:08.2660252+00:00",
    "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",
                "path": "Bundle",
                "comment": "In this implementation, this bundle will be a searchset. If it is not blank, this will be either a collection of Encounters from Search Encounter interaction or DocumentReference from Search Document interaction."
            },
            {
                "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
            },
            {
                "id": "Bundle.link",
                "path": "Bundle.link",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.resource",
                "path": "Bundle.entry.resource",
                "definition": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.\n\nIn this implementation, this will either be an Encounter from Search Enounter interaction or DocumentReference from Search Documents interaction.",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.search",
                "path": "Bundle.entry.search",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.search.mode",
                "path": "Bundle.entry.search.mode",
                "min": 1
            }
        ]
    }
}

Usage

This resource captures the search result of MI records returned from the miCDR. This resource is only used for FHIR query.

Notes

.meta.profile

  • must contain the canonical URI of the profile

.type

  • fixed to value 'searchset'

.total

  • contains the number of resources found in the search result matching the search criteria

.link

  • contains the URI for the next and previous set of results. This is used for paging results.

.entry

  • Each entry will contain an MI record or a resource for support information:
    • for "FetchDocumentReference" query, the main entry will be DocumentReference resources
    • for "Search MI Order" query, the main entry will be ServiceRequest resources
    • for "Search MI Report" query, the main entry will be DiagnosticReport resources
    • for "Search Imaging Study" query, the main entry will be ImagingStudy resources
    • Other entries will contain supporting resources (Patient, Practitioner, Organization, Encounter, etc)