Pan-Canadian Care Service Directory (1.0.0-DFT)

DFT - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions

Capability Statement Bulk Export - Consumer

REST Capabilities Client

Mode

Client

Security

Description

Servers are required to implement OAuth 2.0 access management for bulk data export in accordance with the SMART Backend Services: Authorization Guide. Implementations MAY also support alternative authentication mechanisms such as mutual-TLS or signed URLs.

Resource Interactions

Resource Type	Supported Profiles	SearchType	Read
HealthcareService	HealthcareService	SHOULD	SHOULD
Location	Location	SHOULD	SHOULD
Organization	Organization	SHOULD	SHOULD
OrganizationAffiliation	OrganizationAffiliation	SHOULD	SHOULD
Practitioner	Practitioner	SHOULD	SHOULD
PractitionerRole	PractitionerRole	SHOULD	SHOULD

Global Operations

Operation	Reference	Documentation	Level
bulk-export	BulkDataExport	FHIR Operation to export data from a FHIR server. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the `_type` parameter.	SHALL

CapabilityStatement

id : CA-CSD-CareServicesSelectiveConsumer-BulkExport

url : http://fhir.infoway-inforoute.ca/io/CA-CSD/CapabilityStatement/CA-CSD-CareServicesSelectiveConsumer-BulkExport

name : CA_CSD_Care_Services_Selective_Consumer_BulkExport

title : CA:CSD Care Services Selective Consumer BulkExport

status : draft

publisher : Canada Health Infoway

contact

name : Canada Health Infoway

telecom

system : email

value : interoperability@infoway-inforoute.ca

description : Servers are encouraged to implement OAuth 2.0 access management in accordance with the [SMART Backend Services: Authorization Guide](https://hl7.org/fhir/smart-app-launch/backend-services.html). Implementations MAY include non-RESTful services that use authorization schemes other than OAuth 2.0, such as mutual-TLS or signed URLs.

copyright : Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).

kind : requirements

fhirVersion : 4.0.1

format : application/fhir+xml

format : application/fhir+json

rest

mode : client

security

description : Servers are required to implement OAuth 2.0 access management for bulk data export in accordance with the SMART Backend Services: Authorization Guide. Implementations MAY also support alternative authentication mechanisms such as mutual-TLS or signed URLs.

resource

type : HealthcareService

supportedProfile : http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : read

resource

type : Location

supportedProfile : http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : read

resource

type : Organization

supportedProfile : http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : read

resource

type : OrganizationAffiliation

supportedProfile : http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-OrganizationAffiliation

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : read

resource

type : Practitioner

supportedProfile : http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Practitioner

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : read

resource

type : PractitionerRole

supportedProfile : http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-PractitionerRole

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

code : read

operation

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

name : bulk-export

definition : http://fhir.infoway-inforoute.ca/io/CA-CSD/OperationDefinition/bulk-export

documentation : FHIR Operation to export data from a FHIR server. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the `_type` parameter.

<CapabilityStatement xmlns="http://hl7.org/fhir">
    <id value="CA-CSD-CareServicesSelectiveConsumer-BulkExport" />
    <url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/CapabilityStatement/CA-CSD-CareServicesSelectiveConsumer-BulkExport" />
    <name value="CA_CSD_Care_Services_Selective_Consumer_BulkExport" />
    <title value="CA:CSD Care Services Selective Consumer BulkExport" />
    <status value="draft" />
    <publisher value="Canada Health Infoway" />
    <contact>
        <name value="Canada Health Infoway" />
        <telecom>
            <system value="email" />
            <value value="interoperability@infoway-inforoute.ca" />
        </telecom>
    </contact>
    <description value="Servers are encouraged to implement OAuth 2.0 access management in accordance with the [SMART Backend Services: Authorization Guide](https://hl7.org/fhir/smart-app-launch/backend-services.html).  Implementations MAY include non-RESTful services that use authorization schemes other than OAuth 2.0, such as mutual-TLS or signed URLs." />
    <copyright value="Copyright &#169; 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
    <kind value="requirements" />
    <fhirVersion value="4.0.1" />
    <format value="application/fhir+xml" />
    <format value="application/fhir+json" />
    <rest>
        <mode value="client" />
        <security>
            <description value="Servers are required to implement OAuth 2.0 access management for bulk data export in accordance with the SMART Backend Services: Authorization Guide. Implementations MAY also support alternative authentication mechanisms such as mutual-TLS or signed URLs." />
        </security>
        <resource>
            <type value="HealthcareService" />
            <supportedProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="read" />
            </interaction>
        </resource>
        <resource>
            <type value="Location" />
            <supportedProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="read" />
            </interaction>
        </resource>
        <resource>
            <type value="Organization" />
            <supportedProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="read" />
            </interaction>
        </resource>
        <resource>
            <type value="OrganizationAffiliation" />
            <supportedProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-OrganizationAffiliation" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="read" />
            </interaction>
        </resource>
        <resource>
            <type value="Practitioner" />
            <supportedProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Practitioner" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="read" />
            </interaction>
        </resource>
        <resource>
            <type value="PractitionerRole" />
            <supportedProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-PractitionerRole" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="read" />
            </interaction>
        </resource>
        <operation>
            <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                <valueCode value="SHALL" />
            </extension>
            <name value="bulk-export" />
            <definition value="http://fhir.infoway-inforoute.ca/io/CA-CSD/OperationDefinition/bulk-export" />
            <documentation value="FHIR Operation to export data from a FHIR server. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the `_type` parameter." />
        </operation>
    </rest>
</CapabilityStatement>

{
    "resourceType": "CapabilityStatement",
    "id": "CA-CSD-CareServicesSelectiveConsumer-BulkExport",
    "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/CapabilityStatement/CA-CSD-CareServicesSelectiveConsumer-BulkExport",
    "name": "CA_CSD_Care_Services_Selective_Consumer_BulkExport",
    "title": "CA:CSD Care Services Selective Consumer BulkExport",
    "status": "draft",
    "publisher": "Canada Health Infoway",
    "contact":  [
        {
            "name": "Canada Health Infoway",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperability@infoway-inforoute.ca"
                }
            ]
        }
    ],
    "description": "Servers are encouraged to implement OAuth 2.0 access management in accordance with the [SMART Backend Services: Authorization Guide](https://hl7.org/fhir/smart-app-launch/backend-services.html).  Implementations MAY include non-RESTful services that use authorization schemes other than OAuth 2.0, such as mutual-TLS or signed URLs.",
    "copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
    "kind": "requirements",
    "fhirVersion": "4.0.1",
    "format":  [
        "application/fhir+xml",
        "application/fhir+json"
    ],
    "rest":  [
        {
            "mode": "client",
            "security": {
                "description": "Servers are required to implement OAuth 2.0 access management for bulk data export in accordance with the SMART Backend Services: Authorization Guide. Implementations MAY also support alternative authentication mechanisms such as mutual-TLS or signed URLs."
            },
            "resource":  [
                {
                    "type": "HealthcareService",
                    "supportedProfile":  [
                        "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService"
                    ],
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "search-type"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "read"
                        }
                    ]
                },
                {
                    "type": "Location",
                    "supportedProfile":  [
                        "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location"
                    ],
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "search-type"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "read"
                        }
                    ]
                },
                {
                    "type": "Organization",
                    "supportedProfile":  [
                        "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization"
                    ],
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "search-type"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "read"
                        }
                    ]
                },
                {
                    "type": "OrganizationAffiliation",
                    "supportedProfile":  [
                        "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-OrganizationAffiliation"
                    ],
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "search-type"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "read"
                        }
                    ]
                },
                {
                    "type": "Practitioner",
                    "supportedProfile":  [
                        "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Practitioner"
                    ],
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "search-type"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "read"
                        }
                    ]
                },
                {
                    "type": "PractitionerRole",
                    "supportedProfile":  [
                        "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-PractitionerRole"
                    ],
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "search-type"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "read"
                        }
                    ]
                }
            ],
            "operation":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                            "valueCode": "SHALL"
                        }
                    ],
                    "name": "bulk-export",
                    "definition": "http://fhir.infoway-inforoute.ca/io/CA-CSD/OperationDefinition/bulk-export",
                    "documentation": "FHIR Operation to export data from a FHIR server. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the `_type` parameter."
                }
            ]
        }
    ]
}