--- swagger: "2.0" info: description: "The FHIR API for the Canadian Vaccine Catalogue" version: "1.0.0" title: "Canadian Vaccine Catalogue" contact: name: "Cameron bell" url: "https://cvc.canimmunize.ca" email: "cambell@ohri.ca" host: "fhirtest.uhn.ca" basePath: "/baseDstu3" schemes: - "https" consumes: - "application/json" produces: - "application/json" paths: /ValueSet/CVC-Tradename-Valueset: get: summary: "Get Tradename Concepts" parameters: [] responses: 200: description: "Status 200" /ValueSet/CVC-Generic-Valueset: get: summary: "Get Generic Concepts (Agents)" description: "Get the CVC Generic Concepts." parameters: [] responses: 200: description: "Status 200" /Medication: get: summary: "Get All Medications" parameters: [] responses: 200: description: "Status 200" /Medication/{din}: get: summary: "Get Medication by DIN" parameters: [] responses: 200: description: "Status 200" parameters: - name: "din" in: "path" required: true type: "string" /ValueSet/CVC-Disease-Valueset: get: summary: "Get Disease Concepts" parameters: [] responses: 200: description: "Status 200" /ValueSet/CVC-Antigen-Valueset: get: summary: "/ValueSet/CVC-Antigen-Valueset" parameters: [] responses: 200: description: "Status 200" definitions: CVC Medication Profile: type: "object" properties: resourceType: type: "string" id: type: "string" meta: type: "object" properties: versionId: type: "string" lastUpdated: type: "string" language: type: "string" text: type: "object" properties: status: type: "string" div: type: "string" code: type: "object" description: "Codes that identify this vaccination" properties: coding: type: "array" description: "Code defined by a terminology system" items: type: "object" properties: system: type: "string" description: "The identification of the code system that defines\ \ the meaning of the symbol in the code." code: type: "string" description: "Symbol in syntax defined by the system" display: type: "string" description: "Representation defined by the system" isBrand: type: "boolean" manufacturer: type: "object" description: "Manufacturer of the vaccine" properties: identifier: type: "object" properties: system: type: "string" value: type: "string" display: type: "string" description: "Text name of the manufacturer" package: type: "object" description: "Details about packaged vaccinations" properties: batch: type: "array" description: "Identifies a single production run" items: type: "object" properties: lotNumber: type: "string" description: "Identifier assigned to batch" expirationDate: type: "string" description: "When batch will expire" description: "ca-vaccine-catalog-profile-Medication profile based on http://hl7.org/FHIR/STU3/medication.html" example: "{\r\n \"resourceType\": \"Medication\",\r\n \"id\": \"CVC-Medication-1\"\ ,\r\n \"meta\": {\r\n \"versionId\": \"1\",\r\n \"lastUpdated\": \"2017-02-28T10:49:44.142-05:00\"\ \r\n },\r\n \"language\": \"en-US\",\r\n \"text\": {\r\n \"status\": \"\ generated\",\r\n \"div\": \"

%Some xhtml content%

\"\r\n },\r\n \"code\": {\r\n \"coding\"\ : [\r\n {\r\n \"system\": \"http://hl7.org/fhir/sid/ca-hc-din\"\ ,\r\n \"code\": \"01959034\",\r\n \"display\": \"ACT-HIB\"\r\n\ \ },\r\n {\r\n \"system\": \"http://snomed.info/sct\",\r\n\ \ \"code\": \"7031000087105\",\r\n \"display\": \"ACT-HIB 10 micrograms\ \ per 0.5 milliliter powder and diluent for solution for injection Sanofi Pasteur\ \ SA (product)\"\r\n },\r\n {\r\n \"system\": \" http://www.gs1.org/gtin\"\ ,\r\n \"code\": \"1234567891\",\r\n \"display\": \"Display Name\ \ for GTIN 1234567891\"\r\n },\r\n {\r\n \"system\": \" http://www.gs1.org/gtin\"\ ,\r\n \"code\": \"1234567891\",\r\n \"display\": \"Display Name\ \ for GTIN 1234567892\"\r\n },\r\n {\r\n \"system\": \" http://www.gs1.org/gtin\"\ ,\r\n \"code\": \"1234567891\",\r\n \"display\": \"Display Name\ \ for GTIN 1234567893\"\r\n }\r\n ]\r\n },\r\n \"isBrand\": true,\r\ \n \"manufacturer\": {\r\n \"identifier\": {\r\n \"system\": \"http://fhir.test.com\"\ ,\r\n \"value\": \"12345\"\r\n },\r\n \"display\": \"SANOFI PASTEUR\ \ LIMITED\"\r\n },\r\n \"package\": {\r\n \"batch\": [\r\n {\r\n \ \ \"lotNumber\": \"12345\",\r\n \"expirationDate\": \"2019-12-12\"\ \r\n },\r\n {\r\n \"lotNumber\": \"12346\",\r\n \"expirationDate\"\ : \"2019-12-19\"\r\n },\r\n {\r\n \"lotNumber\": \"12347\"\ ,\r\n \"expirationDate\": \"2019-12-26\"\r\n }\r\n ]\r\n }\r\ \n}\r\n" CVC ValueSet Profile: type: "object" properties: resourceType: type: "string" id: type: "string" meta: type: "object" properties: versionId: type: "string" lastUpdated: type: "string" compose: type: "object" description: "Definition of the content of the value set (CLD)" properties: include: type: "array" description: "Include one or more codes from a code system or other value\ \ set(s)" items: type: "object" properties: system: type: "string" description: "http://snomed.info/sct (SNOMED CT)" version: type: "string" concept: type: "array" items: type: "object" properties: code: type: "string" description: "SNOMED CT Identifier of the concept" display: type: "string" description: "enDisplayName" designation: type: "array" description: "Additional representations for this concept" items: type: "object" properties: language: type: "string" description: "Language of the designation" use: type: "object" description: "Details how this designation would be\ \ used" properties: system: type: "string" description: "The identification of the code system\ \ that defines the meaning of the symbol in the\ \ code." code: type: "string" description: "Symbol in syntax defined by the system" display: type: "string" description: "A representation of the meaning of\ \ the code in the system, following the rules\ \ of the system." value: type: "string" description: "The text value for this designation" description: "ca-vaccine-catalog-profile-VakueSet profile based on http://www.hl7.org/fhir/STU3/valueset.html " example: "{\r\n \"resourceType\": \"ValueSet\",\r\n \"id\": \"CVC-ValueSet-VaccineCode\"\ ,\r\n \"meta\": {\r\n \"versionId\": \"1\",\r\n \"lastUpdated\": \"2017-02-28T10:49:44.142-05:00\"\ \r\n },\r\n \"compose\": {\r\n \"include\": [\r\n {\r\n \"\ system\": \"http://snomed.info/sct\",\r\n \"version\": \"CA-20170430\"\ ,\r\n \"concept\": [\r\n {\r\n \"code\": \"7481000087104\"\ ,\r\n \"display\": \"Adacel-Polio suspension for injection Sanofi\ \ Pasteur Limited (product)\",\r\n \"designation\": [\r\n \ \ {\r\n \"language\": \"en\",\r\n \"use\"\ : {\r\n \"system\": \"http://snomed.info/sct\",\r\n \ \ \"code\": \"900000000000550004\",\r\n \"display\"\ : \"Definition\"\r\n },\r\n \"value\": \"Adacel-Polio\"\ \r\n },\r\n {\r\n \"language\": \"\ fr\",\r\n \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"900000000000550004\",\r\n \ \ \"display\": \"Definition\"\r\n },\r\n \"\ value\": \"Adacel-Polio\"\r\n },\r\n {\r\n \ \ \"language\": \"en\",\r\n \"use\": {\r\n \ \ \"system\": \"http://snomed.info/sct\",\r\n \"code\"\ : \"900000000000548007\",\r\n \"display\": \"Preferred\"\r\n\ \ },\r\n \"value\": \"Tdap-IPV Adacel-Polio SP\"\ \r\n },\r\n {\r\n \"language\": \"\ fr\",\r\n \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"900000000000548007\",\r\n \ \ \"display\": \"Preferred\"\r\n },\r\n \"value\"\ : \"dcaT-VPI Adacel-Polio SP\"\r\n },\r\n {\r\n \ \ \"language\": \"en\",\r\n \"use\": {\r\n \ \ \"system\": \"http://snomed.info/sct\",\r\n \"\ code\": \"900000000000013009\",\r\n \"display\": \"Synonym\"\ \r\n },\r\n \"value\": \"[Tdap-IPV] Adacel-Polio\"\ \r\n },\r\n {\r\n \"language\": \"\ fr\",\r\n \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"900000000000013009\",\r\n \ \ \"display\": \"Synonym\"\r\n },\r\n \"value\"\ : \"[dcaT-VPI] Adacel-Polio\"\r\n },\r\n {\r\n \ \ \"language\": \"en\",\r\n \"use\": {\r\n \ \ \"system\": \"http://snomed.info/sct\",\r\n \"\ code\": \"398223008\",\r\n \"display\": \"Abbreviation\"\r\n\ \ },\r\n \"value\": \"Tdap-IPV\"\r\n \ \ },\r\n {\r\n \"language\": \"fr\",\r\n \ \ \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"398223008\",\r\n \"display\"\ : \"Abbreviation\"\r\n },\r\n \"value\": \"dcaT-VPI\"\ \r\n }\r\n ]\r\n },\r\n {\r\n \ \ \"code\": \"7581000087103\",\r\n \"display\": \"Agriflu\"\ ,\r\n \"designation\": [\r\n {\r\n \"\ language\": \"en\",\r\n \"use\": {\r\n \"system\"\ : \"http://snomed.info/sct\",\r\n \"code\": \"900000000000550004\"\ ,\r\n \"display\": \"Definition\"\r\n },\r\n\ \ \"value\": \"Agriflu\"\r\n },\r\n \ \ {\r\n \"language\": \"fr\",\r\n \"use\": {\r\ \n \"system\": \"http://snomed.info/sct\",\r\n \ \ \"code\": \"900000000000550004\",\r\n \"display\": \"\ Definition\"\r\n },\r\n \"value\": \"Agriflu\"\ \r\n },\r\n {\r\n \"language\": \"\ en\",\r\n \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"900000000000548007\",\r\n \ \ \"display\": \"Preferred\"\r\n },\r\n \"value\"\ : \"Inf Agriflu NVD\"\r\n },\r\n {\r\n \ \ \"language\": \"fr\",\r\n \"use\": {\r\n \ \ \"system\": \"http://snomed.info/sct\",\r\n \"code\":\ \ \"900000000000548007\",\r\n \"display\": \"Preferred\"\r\n\ \ },\r\n \"value\": \"Inf Agriflu NVD\"\r\n \ \ },\r\n {\r\n \"language\": \"en\",\r\ \n \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"900000000000013009\",\r\n \ \ \"display\": \"Synonym\"\r\n },\r\n \"value\"\ : \"[Inf] Agriflu\"\r\n },\r\n {\r\n \ \ \"language\": \"fr\",\r\n \"use\": {\r\n \ \ \"system\": \"http://snomed.info/sct\",\r\n \"code\": \"\ 900000000000013009\",\r\n \"display\": \"Synonym\"\r\n \ \ },\r\n \"value\": \"[Inf] Agriflu\"\r\n \ \ },\r\n {\r\n \"language\": \"en\",\r\n \ \ \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"398223008\",\r\n \"display\"\ : \"Abbreviation\"\r\n },\r\n \"value\": \"Inf\"\ \r\n },\r\n {\r\n \"language\": \"\ fr\",\r\n \"use\": {\r\n \"system\": \"http://snomed.info/sct\"\ ,\r\n \"code\": \"398223008\",\r\n \"display\"\ : \"Abbreviation\"\r\n },\r\n \"value\": \"Inf\"\ \r\n }\r\n ]\r\n }\r\n ]\r\n }\r\ \n ]\r\n }\r\n}\r\n"