| Package | ca.on.oh-dhdr |
| Resource Type | CapabilityStatement |
| Id | dhdr-consumer-ig-capabilitystatement |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=ca.on.oh-dhdr@4.0.2-alpha1.0.6&canonical=https://ontariohealth.ca/fhir/dhdr-consumer/CapabilityStatement/metadata-consumer |
| URL | https://ontariohealth.ca/fhir/dhdr-consumer/CapabilityStatement/metadata-consumer |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-03-12 |
| Name | DhdrConsumerIGCapabilityStatement |
| Title | DHDR Consumer IG Capability Statement |
| Realm | ca |
| Description | This CapabilityStatement defines the search capabilities of the Consumer IG. It provides access to document bundles for medication records using search operations. |
| Purpose | Defines the supported search interaction and search parameters for consumer applications accessing the Digital Health Drug Repository via FHIR. |
| Copyright | Copyright © Ontario Health |
| Kind | capability |
No resources found
No resources found
No narrative content found in resource
FHIR{
"resourceType": "CapabilityStatement",
"id": "dhdr-consumer-ig-capabilitystatement",
"url": "https://ontariohealth.ca/fhir/dhdr-consumer/CapabilityStatement/metadata-consumer",
"version": "1.0.0",
"name": "DhdrConsumerIGCapabilityStatement",
"title": "DHDR Consumer IG Capability Statement",
"status": "active",
"experimental": false,
"date": "2025-03-12",
"publisher": "Ontario Health",
"contact": [
{
"name": "Ontario Health",
"telecom": [
{
"system": "email",
"value": "DigitalHealthStandards@ontariohealth.ca"
}
]
}
],
"description": "This CapabilityStatement defines the search capabilities of the Consumer IG. It provides access to document bundles for medication records using search operations.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CA",
"display": "Canada"
}
]
}
],
"purpose": "Defines the supported search interaction and search parameters for consumer applications accessing the Digital Health Drug Repository via FHIR.",
"copyright": "Copyright © Ontario Health",
"kind": "capability",
"fhirVersion": "4.0.1",
"format": [
"json",
"xml"
],
"rest": [
{
"mode": "server",
"documentation": "Defines the supported search interaction and search parameters for consumer applications accessing the Digital Health Drug Repository.",
"security": {
"cors": true,
"service": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "SMART-on-FHIR",
"display": "OAuth2 using SMART-on-FHIR"
}
],
"text": "This API supports OAuth2 authentication using SMART-on-FHIR."
}
]
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "Bundle",
"profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Bundle-document",
"documentation": "Supports retrieving document bundles for medication records.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "composition.patient.identifier",
"type": "reference",
"documentation": "Mandatory. Specifies an identifier associated with the patient who is the subject of the medication document. Allowed values include Ontario HCN, MRN or ECID. Health Number Version is not supported. Example: composition.patient.identifier=[id-system-global-base/ca-on-patient-hcn|12345678], composition.patient.identifier=http://ehealthontario.ca/fhir/NamingSystem/id-pharmacy-mrn|123456-987654321, etc."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "composition.patient.gender",
"type": "reference",
"documentation": "Conditional. Specifies the gender of the patient as noted on the Ontario health card. Example: composition.patient.gender=female"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "composition.patient.birthdate",
"type": "reference",
"documentation": "Conditional. Specifies the patient’s birth date as on the Ontario health card. Note: Required when the patient identifier is HCN or MRN. Example: composition.patient.birthdate=1971-11-28"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "composition.type",
"type": "reference",
"documentation": "Mandatory. Specifies the type of document. Example: composition.type=http://loinc.org|29550-1 (Medication Dispense) or composition.type=http://loinc.org|80565-5 (Medication Administration)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "composition.medicationdispense.whenprepared",
"type": "reference",
"documentation": "Optional. Specifies when the medication was prepared for dispensing. Defaults to 120 days back if no lower limit is provided. Prefixes such as gt, lt, ge, le are allowed (default assumed as eq). Example: composition.medicationdispense.whenprepared=gt2018-02-24 or composition.medicationdispense.whenprepared=ge2018-02-25&composition.medicationdispense.whenprepared=le2019-02-27"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "composition.medicationadministration.effective-time",
"type": "reference",
"documentation": "Optional. Specifies the effective time of medication administration. Defaults to 120 days back if no lower limit is provided. Prefixes such as gt, lt, ge, le are allowed (default assumed as eq). Example: composition.medicationadministration.effective-time=gt2018-02-24 or composition.medicationadministration.effective-time=ge2018-02-25&composition.medicationadministration.effective-time=le2019-02-27"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "_sort",
"type": "string",
"documentation": "Optional. Sort order by whenprepared and effective-time parameters. If not indicated, the default sort order is descending by whenprepared or effective-time. Examples: _sort=whenprepared, _sort=-whenprepared, _sort=effective-time, _sort=-effective-time"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "_count",
"type": "number",
"documentation": "Optional. Size limit for response paging. Defaults to 50 records per page, with a configurable maximum page size. Example: _count=10"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "_format",
"type": "string",
"documentation": "Optional. Specifies the response format: JSON (default) or XML. Example: _format=application/fhir+xml"
}
]
}
]
}
]
}