{
"description": "This CapabilityStatement defines the search capabilities of the EHR Consumer IG. It provides access to various EHR profiles using the search operation.",
"_filename": "EHRCapabilityStatement.json",
"package_name": "ca.on.ehr.r4",
"format": [ "json", "xml" ],
"date": "2025-03-16",
"publisher": "Ontario Health",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CA",
"system": "urn:iso:std:iso:3166",
"display": "Canada"
} ]
} ],
"purpose": "Defines the supported search interaction for consumer applications accessing EHR data via FHIR.",
"name": "EhrConsumerIGCapabilityStatement",
"copyright": "Copyright © Ontario Health",
"type": null,
"experimental": "false",
"resourceType": "CapabilityStatement",
"title": "EHR Consumer IG Capability Statement",
"package_version": "1.0.0-snapshot2",
"status": "active",
"id": "ca2387d4-5746-4787-a10c-2179053d41b2",
"kind": "capability",
"url": "https://ontariohealth.ca/fhir/ehr/CapabilityStatement/ehr-consumer",
"version": "1.0.0",
"contact": [ {
"name": "Ontario Health",
"telecom": [ {
"value": "DigitalHealthStandards@ontariohealth.ca",
"system": "email"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "Patient",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Patient",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchParam": [ {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search by patient identifier (e.g. MRN, HCN)."
}, {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by patient name."
}, {
"name": "birthdate",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by date of birth."
} ],
"documentation": "Supports searching Patient resources."
}, {
"type": "Encounter",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by encounter identifier."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search encounters by patient reference."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by encounter status (e.g. in-progress, finished)."
} ],
"documentation": "Supports searching Encounter resources."
}, {
"type": "Practitioner",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Practitioner",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by practitioner identifier."
}, {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by practitioner name."
} ],
"documentation": "Supports searching Practitioner resources."
}, {
"type": "PractitionerRole",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-PractitionerRole",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "practitioner",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by practitioner reference."
}, {
"name": "organization",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by organization reference."
}, {
"name": "role",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by role code for the PractitionerRole resource."
} ],
"documentation": "Supports searching PractitionerRole resources."
}, {
"type": "ServiceRequest",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-ServiceRequest",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by patient reference."
}, {
"name": "encounter",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by encounter reference."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by request status (e.g. active, completed)."
} ],
"documentation": "Supports searching ServiceRequest resources."
}, {
"type": "AllergyIntolerance",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-AllergyIntolerance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by patient reference."
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by clinical status (e.g. active, inactive)."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by allergy intolerance code."
} ],
"documentation": "Supports searching AllergyIntolerance resources."
}, {
"type": "MedicationRequest",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-MedicationRequest",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by patient reference."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by request status (e.g. active, completed)."
}, {
"name": "intent",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by request intent (e.g. order)."
} ],
"documentation": "Supports searching MedicationRequest resources."
}, {
"type": "Condition",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Condition",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by patient reference."
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by condition clinical status (e.g. active, inactive)."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by condition category (e.g. problem-list-item)."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by condition code."
} ],
"documentation": "Supports searching Condition resources."
}, {
"type": "Organization",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Organization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by organization identifier."
}, {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by organization name."
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by organization type (e.g. hospital, clinic)."
} ],
"documentation": "Supports searching Organization resources."
}, {
"type": "Location",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Location",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by location identifier."
}, {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by location name."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by location status (active, inactive)."
} ],
"documentation": "Supports searching Location resources."
}, {
"type": "Medication",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Medication",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchParam": [ {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by medication code (e.g. RxNorm, DIN)."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Search by medication status (e.g. active, entered-in-error)."
} ],
"documentation": "Supports searching Medication resources."
}, {
"type": "OperationOutcome",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-OperationOutcome",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"documentation": "Supports returning OperationOutcome resources (e.g., for errors)."
}, {
"type": "Bundle",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Bundle-searchset",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"documentation": "Supports retrieving searchset bundles."
}, {
"type": "Bundle",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Bundle-document",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"documentation": "Supports retrieving document bundles."
} ],
"security": {
"cors": true,
"service": [ {
"text": "This API supports OAuth2 authentication using SMART-on-FHIR.",
"coding": [ {
"code": "SMART-on-FHIR",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "OAuth2 using SMART-on-FHIR"
} ]
} ]
},
"documentation": "This CapabilityStatement defines the search capabilities of the EHR Consumer IG. It provides access to various EHR profiles using the search operation."
} ]
}