{
  "resourceType": "CapabilityStatement",
  "id": "immunization-consumer",
  "url": "http://ontariohealth.ca/fhir/ir/CapabilityStatement/immunization-consumer",
  "version": "1.0.0",
  "name": "IRConsumerFHIRCapabilityStatement",
  "title": "Immunization Repository FHIR Capability Statement",
  "status": "active",
  "experimental": false,
  "date": "2026-05-29",
  "publisher": "Ontario Health",
  "contact": [
    {
      "name": "Ontario Health",
      "telecom": [
        {
          "system": "email",
          "value": "DigitalHealthStandards@ontariohealth.ca"
        }
      ]
    }
  ],
  "description": "This is the FHIR capability statement for the Immunization Repository server's consumer interface",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CA",
          "display": "Canada"
        }
      ]
    }
  ],
  "purpose": "Immunization Repository capability statement, published for the onboarding, contracting, and operational support of consumer systems retrieving records from the central repository.",
  "copyright": "Copyright © Ontario Health",
  "kind": "capability",
  "software": {
    "name": "Ontario Health Immunization Consumer Client",
    "version": "1.0.0"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "application/json",
    "application/xml"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Support the retrieval of patient's immunization records from the repository",
      "resource": [
        {
          "type": "Bundle",
          "profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-bundle-document",
          "documentation": "Retrieve history of patient's immunizations",
          "interaction": [
            {
              "code": "search-type",
              "documentation": "Search Immunization resources using specified parameters. Supports both GET and POST operation"
            }
          ],
          "versioning": "no-version",
          "conditionalRead": "not-supported",
          "searchParam": [
            {
              "name": "composition.patient.identifier",
              "definition": "http://ehealthontario.ca/fhir/SearchParameter/Bundle-composition-patient-identifier",
              "type": "token",
              "documentation": "Supports search by Ontario Health Number or Client Management System Identifier. Patient Id is a mandatory search parameter"
            },
            {
              "name": "composition.patient.gender",
              "definition": "http://ehealthontario.ca/fhir/SearchParameter/Bundle-composition-patient-gender",
              "type": "token",
              "documentation": "Patient gender - optional"
            },
            {
              "name": "composition.patient.birthdate",
              "definition": "http://ehealthontario.ca/fhir/SearchParameter/Bundle-composition-patient-birthdate",
              "type": "date",
              "documentation": "Patient date of birth - mandatory"
            },
            {
              "name": "composition.immunization.occurrence",
              "definition": "http://ontariohealth.ca/fhir/ir/SearchParameter/bundle-composition-immunization-occurrence",
              "type": "date",
              "documentation": "Date when the immunization administration occurred or was recorded - optional"
            },
            {
              "name": "composition.type",
              "definition": "http://ehealthontario.ca/fhir/SearchParameter/Bundle-composition-type",
              "type": "token",
              "documentation": "Type of the document"
            }
          ]
        }
      ]
    }
  ],
  "document": [
    {
      "mode": "consumer",
      "documentation": "The repository is a document consumer in the sense that it receives and stores documents generated from contributor systems.",
      "profile": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-bundle-document"
    }
  ]
}