{
  "description": "This CapabilityStatement defines the search capabilities of the Consumer IG. It provides access to document bundles for medication records using search operations.",
  "_filename": "dhdr-consumer-ig-capabilitystatement.json",
  "package_name": "ca.on.oh-dhdr",
  "format": [ "json", "xml" ],
  "date": "2025-03-12",
  "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 and search parameters for consumer applications accessing the Digital Health Drug Repository via FHIR.",
  "name": "DhdrConsumerIGCapabilityStatement",
  "copyright": "Copyright © Ontario Health",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "DHDR Consumer IG Capability Statement",
  "package_version": "4.0.2-alpha1.0.6",
  "status": "active",
  "id": "a24f6def-65ed-48d2-b041-3d9603701dce",
  "kind": "capability",
  "url": "https://ontariohealth.ca/fhir/dhdr-consumer/CapabilityStatement/metadata-consumer",
  "version": "1.0.0",
  "contact": [ {
    "name": "Ontario Health",
    "telecom": [ {
      "value": "DigitalHealthStandards@ontariohealth.ca",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Bundle",
      "profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Bundle-document",
      "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": "composition.patient.identifier",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "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."
      }, {
        "name": "composition.patient.gender",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "documentation": "Conditional. Specifies the gender of the patient as noted on the Ontario health card. Example: composition.patient.gender=female"
      }, {
        "name": "composition.patient.birthdate",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "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"
      }, {
        "name": "composition.type",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "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)"
      }, {
        "name": "composition.medicationdispense.whenprepared",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "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"
      }, {
        "name": "composition.medicationadministration.effective-time",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "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"
      }, {
        "name": "_sort",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "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"
      }, {
        "name": "_count",
        "type": "number",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "documentation": "Optional. Size limit for response paging. Defaults to 50 records per page, with a configurable maximum page size. Example: _count=10"
      }, {
        "name": "_format",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "documentation": "Optional. Specifies the response format: JSON (default) or XML. Example: _format=application/fhir+xml"
      } ],
      "documentation": "Supports retrieving document bundles for medication records."
    } ],
    "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": "Defines the supported search interaction and search parameters for consumer applications accessing the Digital Health Drug Repository."
  } ]
}