openapi.json

{"openapi":"3.0.2",
  "info":{"title":"Immunization Fhir API","description":"API","version":"DEVELOPMENT"},"paths":{"/":{"get":{"summary":"Root","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/health":{"get":{"tags":["health"],"summary":"Health","description":"Health check endpoint only returns 200","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/dynamodb/Immunization":{"get":{"tags":["Dynamodb","CRUD","Read"],"summary":"Read Immunization Record","description":"Read Method for Immunization Endpoint","operationId":"read_immunization_record_dynamodb_Immunization_get","parameters":[{"required":true,"schema":{"title":"Nhsnumber","type":"string"},"name":"nhsNumber","in":"query"},{"required":false,"schema":{"title":"Fullurl","type":"string"},"name":"fullUrl","in":"query"},{"required":false,"schema":{"title":"From Date","type":"string"},"name":"from_date","in":"query"},{"required":false,"schema":{"title":"To Date","type":"string","default":"9999-01-01"},"name":"to_date","in":"query"},{"required":false,"schema":{"title":"Include Record","type":"string"},"name":"include_record","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchImmunizationRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Address":{"title":"Address","type":"object","properties":{"use":{"title":"Use","enum":["home","work","temp","old","billing"],"type":"string"},"type":{"title":"Type","enum":["postal","physical","both"],"type":"string"},"text":{"title":"Text","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"line":{"title":"Line","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"city":{"title":"City","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"district":{"title":"District","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"state":{"title":"State","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"postalCode":{"title":"Postalcode","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"country":{"title":"Country","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"period":{"$ref":"#/components/schemas/Period"}},"description":"An address expressed using postal conventions (as opposed to GPS or other location definition formats). \nThis data type may be used to convey addresses for use in delivering mail as well as for visiting \nlocations which might not be valid for mail delivery.\nThere are a variety of postal address formats defined around the world. "},"Annotation":{"title":"Annotation","type":"object","properties":{"author":{"$ref":"#/components/schemas/Author"},"time":{"title":"Time","type":"string","description":"A date, date-time or partial date (e.g. just year or year + month) as used in human communication.","format":"date-time","example":"2015-02-07T13:28:17-05:00"},"text":{"title":"Text","type":"string","description":"A FHIR string (see above) that may contain markdown syntax","example":"A String `with Markdown` in it"}},"description":"Annotation Model "},"Attachment":{"title":"Attachment","type":"object","properties":{"contentType":{"title":"Contenttype","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"language":{"title":"Language","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"data":{"title":"Data","pattern":"(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+","type":"string","description":"A stream of bytes, base64 encoded","example":"eyJmbGF2b3IiOiAiZnJlbmNoIHZhbmlsbGEiLCAic2l6ZSI6ICIyNCBveiJ9"},"url":{"title":"Url","type":"string","description":"A Uniform Resource Locator","example":"http://terminology.hl7.org/CodeSystem/v2-0203"},"size":{"title":"Size","type":"integer","description":"Any non-negative integer in the range 0..2,147,483,647","example":123},"hash":{"title":"Hash","pattern":"(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+","type":"string","description":"A stream of bytes, base64 encoded","example":"eyJmbGF2b3IiOiAiZnJlbmNoIHZhbmlsbGEiLCAic2l6ZSI6ICIyNCBveiJ9"},"title":{"title":"Title","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"creation":{"title":"Creation","type":"string","description":"A date, date-time or partial date (e.g. just year or year + month) as used in human communication.","format":"date-time","example":"2015-02-07T13:28:17-05:00"}},"description":"Attachment Model "},"Author":{"title":"Author","type":"object","properties":{"authorRefernce":{"$ref":"#/components/schemas/Reference"},"authorString":{"title":"Authorstring","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"}},"description":"Author Model "},"BatchImmunizationRead":{"title":"BatchImmunizationRead","required":["type","total","entry"],"type":"object","properties":{"resourceType":{"title":"Resourcetype","enum":["Bundle"],"type":"string","default":"Bundle"},"type":{"title":"Type","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"total":{"title":"Total","type":"integer","description":"A signed integer in the range −2,147,483,648..2,147,483,647 (32-bit; for larger values, use decimal)","example":100},"entry":{"title":"Entry","type":"array","items":{"$ref":"#/components/schemas/Resource"}}},"description":"Model for Multiple records "},"CodeableConceptType":{"title":"CodeableConceptType","type":"object","properties":{"coding":{"title":"Coding","type":"array","items":{"$ref":"#/components/schemas/CodingType"}},"text":{"title":"Text","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"}},"description":"Codeable Concept Data Model "},"CodingType":{"title":"CodingType","type":"object","properties":{"system":{"title":"System","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"version":{"title":"Version","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"code":{"title":"Code","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"display":{"title":"Display","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"userSelected":{"title":"Userselected","type":"boolean"}},"description":"Code Data Model "},"Communication":{"title":"Communication","required":["language"],"type":"object","properties":{"language":{"$ref":"#/components/schemas/CodeableConceptType"},"preferred":{"title":"Preferred","type":"boolean","description":"Boolean Field","example":"True"}},"description":"Communication Model "},"Contact":{"title":"Contact","type":"object","properties":{"relationship":{"title":"Relationship","type":"array","items":{"$ref":"#/components/schemas/CodeableConceptType"}},"name":{"$ref":"#/components/schemas/HumanName"},"telecom":{"title":"Telecom","type":"array","items":{"$ref":"#/components/schemas/ContactPoint"}},"address":{"$ref":"#/components/schemas/Address"},"gender":{"title":"Gender","enum":["male","female","other","unknown"],"type":"string"},"organization":{"$ref":"#/components/schemas/Reference"},"period":{"$ref":"#/components/schemas/Period"}},"description":"Contact Model "},"ContactPoint":{"title":"ContactPoint","type":"object","properties":{"system":{"title":"System","enum":["phone","fax","email","pager","url","sms","other"],"type":"string"},"value":{"title":"Value","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"use":{"title":"Use","enum":["home","work","temp","old","mobile"],"type":"string"},"rank":{"title":"Rank","exclusiveMinimum":0.0,"type":"integer","description":"Any positive integer in the range 1..2,147,483,647","example":123},"period":{"$ref":"#/components/schemas/Period"}},"description":"Details for all kinds of technology-mediated contact points \nfor a person or organization, including telephone, email, etc. "},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"HumanName":{"title":"HumanName","type":"object","properties":{"use":{"title":"Use","enum":["usual","official","temp","nickname","anonymous","old","maiden"],"type":"string"},"text":{"title":"Text","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"family":{"title":"Family","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"given":{"title":"Given","type":"array","items":{"type":"string"}},"prefix":{"title":"Prefix","type":"array","items":{"type":"string"}},"suffix":{"title":"Suffix","type":"array","items":{"type":"string"}},"period":{"$ref":"#/components/schemas/Period"}},"description":"A name of a human with text, parts and usage information. "},"Identifier":{"title":"Identifier","type":"object","properties":{"use_type":{"title":"Use Type","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"type":{"$ref":"#/components/schemas/CodeableConceptType"},"system":{"title":"System","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"value":{"title":"Value","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"period":{"$ref":"#/components/schemas/Period"},"assigner":{"$ref":"#/components/schemas/Reference"}},"description":"Identifier Data Model "},"Immunization":{"title":"Immunization","required":["resourceType","status","vaccineCode","patient","recorded"],"type":"object","properties":{"resourceType":{"title":"Resourcetype","enum":["Immunization"],"type":"string"},"identifier":{"title":"Identifier","type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"status":{"title":"Status","enum":["completed","entered-in-error","not-done"],"type":"string"},"statusReason":{"$ref":"#/components/schemas/CodeableConceptType"},"vaccineCode":{"$ref":"#/components/schemas/CodeableConceptType"},"patient":{"$ref":"#/components/schemas/Reference"},"encounter":{"$ref":"#/components/schemas/Reference"},"occurrenceDateTime":{"title":"Occurrencedatetime","type":"string","description":"A date, date-time or partial date (e.g. just year or year + month) as used in human communication.","format":"date-time","example":"2015-02-07T13:28:17-05:00"},"occurenceString":{"title":"Occurencestring","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"recorded":{"title":"Recorded","type":"string","description":"A date, or partial date (e.g. just year or year + month) as used in human communication","format":"date","example":"1905-08-23"},"primarySource":{"title":"Primarysource","type":"boolean","description":"Boolean Field","example":"True"},"reportOrigin":{"$ref":"#/components/schemas/CodeableConceptType"},"location":{"$ref":"#/components/schemas/Reference"},"manufacturer":{"$ref":"#/components/schemas/Reference"},"lotNumber":{"title":"Lotnumber","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"expirationDate":{"title":"Expirationdate","type":"string","description":"A date, or partial date (e.g. just year or year + month) as used in human communication","format":"date","example":"1905-08-23"},"site":{"$ref":"#/components/schemas/CodeableConceptType"},"route":{"$ref":"#/components/schemas/CodeableConceptType"},"doseQuantity":{"$ref":"#/components/schemas/Quantity"},"performer":{"title":"Performer","type":"array","items":{"$ref":"#/components/schemas/Performer"}},"note":{"title":"Note","type":"array","items":{"$ref":"#/components/schemas/Annotation"}},"reasonCode":{"title":"Reasoncode","type":"array","items":{"$ref":"#/components/schemas/CodeableConceptType"}},"reasonReference":{"title":"Reasonreference","type":"array","items":{"$ref":"#/components/schemas/Reference"}},"isSubpotent":{"title":"Issubpotent","type":"boolean","description":"Boolean Field","example":"True"},"subpotentReason":{"title":"Subpotentreason","type":"array","items":{"$ref":"#/components/schemas/CodeableConceptType"}},"education":{"title":"Education","type":"array","items":{"type":"object"}},"procotolApplied":{"title":"Procotolapplied","type":"array","items":{"$ref":"#/components/schemas/ProtocolApplied"}}},"description":"Immunization Record for Reading "},"Link":{"title":"Link","required":["other","type"],"type":"object","properties":{"other":{"$ref":"#/components/schemas/Reference"},"type":{"title":"Type","enum":["replaced-by","replaces","refer","seealso"],"type":"string"}},"description":"Link Model "},"Patient":{"title":"Patient","required":["resourceType","active","name"],"type":"object","properties":{"resourceType":{"title":"Resourcetype","enum":["Patient"],"type":"string"},"identifier":{"title":"Identifier","type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"active":{"title":"Active","type":"boolean","description":"Boolean Field","example":"True"},"name":{"title":"Name","type":"array","items":{"$ref":"#/components/schemas/HumanName"}},"telecom":{"title":"Telecom","type":"array","items":{"$ref":"#/components/schemas/ContactPoint"}},"gender":{"title":"Gender","enum":["male","female","other","unknown"],"type":"string"},"birthDate":{"title":"Birthdate","type":"string","description":"A date, or partial date (e.g. just year or year + month) as used in human communication","example":"1905-08-23"},"deceasedBoolean":{"title":"Deceasedboolean","type":"boolean","description":"Boolean Field","example":"True"},"deceasedDateTime":{"title":"Deceaseddatetime","type":"string","description":"A date, date-time or partial date (e.g. just year or year + month) as used in human communication.","format":"date-time","example":"2015-02-07T13:28:17-05:00"},"address":{"$ref":"#/components/schemas/Address"},"maritalStatus":{"$ref":"#/components/schemas/CodeableConceptType"},"multipleBirthBoolean":{"title":"Multiplebirthboolean","type":"boolean","description":"Boolean Field","example":"True"},"multipleBirthInteger":{"title":"Multiplebirthinteger","type":"integer","description":"A signed integer in the range −2,147,483,648..2,147,483,647 (32-bit; for larger values, use decimal)","example":100},"photo":{"title":"Photo","type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"contact":{"title":"Contact","type":"array","items":{"$ref":"#/components/schemas/Contact"}},"communication":{"title":"Communication","type":"array","items":{"$ref":"#/components/schemas/Communication"}},"generalPractitioner":{"title":"Generalpractitioner","type":"array","items":{"$ref":"#/components/schemas/Reference"}},"managingOrganization":{"$ref":"#/components/schemas/Reference"},"link":{"title":"Link","type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Patient Base Model "},"Performer":{"title":"Performer","required":["actor"],"type":"object","properties":{"function":{"$ref":"#/components/schemas/CodeableConceptType"},"actor":{"$ref":"#/components/schemas/Reference"}}},"Period":{"title":"Period","required":["start","end"],"type":"object","properties":{"start":{"title":"Start","type":"string","description":"A date, date-time or partial date (e.g. just year or year + month) as used in human communication.","format":"date-time","example":"2015-02-07T13:28:17-05:00"},"end":{"title":"End","type":"string","description":"A date, date-time or partial date (e.g. just year or year + month) as used in human communication.","format":"date-time","example":"2015-02-07T13:28:17-05:00"}},"description":"A time period defined by a start and end date/time. "},"ProtocolApplied":{"title":"ProtocolApplied","type":"object","properties":{"series":{"title":"Series","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"authority":{"$ref":"#/components/schemas/Reference"},"targetDisease":{"title":"Targetdisease","type":"array","items":{"$ref":"#/components/schemas/CodeableConceptType"}},"doseNumberPositiveInt":{"title":"Dosenumberpositiveint","exclusiveMinimum":0.0,"type":"integer","description":"Any positive integer in the range 1..2,147,483,647","example":123},"doseNumberString":{"title":"Dosenumberstring","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"seriesDosesPositiveInt":{"title":"Seriesdosespositiveint","exclusiveMinimum":0.0,"type":"integer","description":"Any positive integer in the range 1..2,147,483,647","example":123},"seriesDosesString":{"title":"Seriesdosesstring","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"}}},"Quantity":{"title":"Quantity","type":"object","properties":{"value":{"title":"Value","type":"number","description":"Rational numbers that have a decimal representation. See below about the precision of the number","example":100.01},"comparator":{"title":"Comparator","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string","description":"Indicates that the value is taken from a set of controlled strings defined elsewhere","example":"home"},"unit":{"title":"Unit","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"system":{"title":"System","pattern":"\\S*","type":"string","description":"A Uniform Resource Identifier Reference","example":"urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7"},"code":{"title":"Code","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string","description":"Indicates that the value is taken from a set of controlled strings defined elsewhere","example":"home"}},"description":"Quantity Type "},"Reference":{"title":"Reference","type":"object","properties":{"reference":{"title":"Reference","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"type":{"title":"Type","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"},"identifier":{"$ref":"#/components/schemas/Identifier"},"display":{"title":"Display","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A sequence of Unicode characters","example":"text"}},"description":"Reference data Model "},"Resource":{"title":"Resource","required":["fullUrl","resource"],"type":"object","properties":{"fullUrl":{"title":"Fullurl","pattern":"\\S*","type":"string","description":"A Uniform Resource Identifier Reference","example":"urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7"},"resource":{"title":"Resource","anyOf":[{"$ref":"#/components/schemas/Immunization"},{"$ref":"#/components/schemas/Patient"}]},"search":{"title":"Search","type":"object","default":{"mode":"match"}}},"description":"Wrapper Model for returned resource "},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}}}