Immunization_GET
GET {{baseUrl}}/Immunization?patient=<string>&location=<string>&manufacturer=<string>&practitioner=<string>&reaction=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&date=<date>&identifier=<string>&dose-sequence=<double>&lot-number=<string>¬given=<string>&reaction-date=<date>&reason=<string>&reason-not-given=<string>&status=<string>&vaccine-code=<string>&_format=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
patient | string | Multiple Resources: |
-
ReferralRequest: Who the referral is about
-
DocumentManifest: The subject of the set of documents
-
Goal: Who this goal is intended for
-
Consent: Who the consent applies to
-
DocumentReference: Who/what is the subject of the document
-
ImagingManifest: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)
-
RiskAssessment: Who/what does assessment apply to?
-
CareTeam: Who care team is for
-
ImagingStudy: Who the study is about
-
FamilyMemberHistory: The identity of a subject to list family member history items for
-
Encounter: The patient ro group present at the encounter
-
DeviceUseStatement: Search by subject - a patient
-
DeviceRequest: Individual the service is ordered for
-
AllergyIntolerance: Who the sensitivity is for
-
CarePlan: Who care plan is for
-
EpisodeOfCare: The patient who is the focus of this episode of care
-
Procedure: Search by subject - a patient
-
List: If all resources have the same subject
-
Immunization: The patient for the vaccination record
-
VisionPrescription: The identity of a patient to list dispenses for
-
ProcedureRequest: Search by subject - a patient
-
Flag: The identity of a subject to list flags for
-
Observation: The subject that the observation is about (if patient)
-
DiagnosticReport: The subject of the report if a patient
-
NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement
-
Condition: Who has the condition?
-
Composition: Who and/or what the composition is about
-
DetectedIssue: Associated patient
-
SupplyDelivery: Patient for whom the item is supplied
-
ClinicalImpression: Patient or group assessed | |
location
| string | | The service delivery location or facility in which the vaccine was / was to be administered | |manufacturer
| string | | Vaccine Manufacturer | |practitioner
| string | | The practitioner who played a role in the vaccination | |reaction
| string | | Additional information on reaction | |_id
| string | | Logical id of this artifact | |_lastUpdated
| string | | When the resource version last changed | |_profile
| string | | Profiles this resource claims to conform to | |_security
| string | | Security Labels applied to this resource | |_tag
| string | | Tags applied to this resource | |date
| string | | Multiple Resources: -
Consent: When this Consent was created or indexed
-
SupplyRequest: When the request was made
-
RiskAssessment: When was assessment made?
-
CareTeam: Time period team covers
-
FamilyMemberHistory: When history was captured/updated
-
Encounter: A date within the period the Encounter lasted
-
AllergyIntolerance: Date record was believed accurate
-
CarePlan: Time period plan covers
-
EpisodeOfCare: The provided date search value falls within the episode of care's period
-
Procedure: Date/Period the procedure was performed
-
List: When the list was prepared
-
Immunization: Vaccination (non)-Administration Date
-
Flag: Time period when flag is active
-
Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period
-
DiagnosticReport: The clinically relevant time of the report
-
Composition: Composition editing time
-
DetectedIssue: When identified
-
ClinicalImpression: When the assessment was documented | |
identifier
| string | | Multiple Resources: -
DocumentManifest: Unique Identifier for the set of documents
-
Goal: External Ids for this goal
-
Consent: Identifier for this record (external references)
-
DocumentReference: Master Version Specific Identifier
-
SupplyRequest: Unique identifier
-
RiskAssessment: Unique identifier for the assessment
-
CareTeam: External Ids for this team
-
ImagingStudy: Other identifiers for the Study
-
FamilyMemberHistory: A search by a record identifier
-
Encounter: Identifier(s) by which this encounter is known
-
DeviceRequest: Business identifier for request/order
-
AllergyIntolerance: External ids for this item
-
CarePlan: External Ids for this plan
-
EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare
-
Procedure: A unique identifier for a procedure
-
List: Business identifier
-
Immunization: Business identifier
-
VisionPrescription: Return prescriptions with this external identifier
-
ProcedureRequest: Identifiers assigned to this order
-
Observation: The unique id for a particular observation
-
DiagnosticReport: An identifier for the report
-
NutritionOrder: Return nutrition orders with this external identifier
-
Condition: A unique identifier of the condition record
-
Composition: Logical identifier of composition (version-independent)
-
DetectedIssue: Unique id for the detected issue
-
SupplyDelivery: External identifier | |
dose-sequence
| string | | Dose number within series | |lot-number
| string | | Vaccine Lot Number | |notgiven
| string | | Administrations which were not given | |reaction-date
| string | | When reaction started | |reason
| string | | Why immunization occurred | |reason-not-given
| string | | Explanation of reason vaccination was not administered | |status
| string | | Immunization event status | |vaccine-code
| string | | Vaccine Product Administered | |_format
| string | | |
RESPONSES
status: OK
[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"\u003cstring\u003e","date":"\u003cstring\u003e","vaccineCode":{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"text":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"wasNotGiven":"\u003cboolean\u003e","reported":"\u003cboolean\u003e","performer":{"reference":"\u003cstring\u003e"},"requester":{"reference":"\u003cstring\u003e"},"encounter":{"reference":"\u003cstring\u003e"},"manufacturer":{"reference":"\u003cstring\u003e"},"location":{"reference":"\u003cstring\u003e"},"lotNumber":"\u003cstring\u003e","expirationDate":"\u003cstring\u003e","site":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"route":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"doseQuantity":{"value":"\u003cnumber\u003e","system":"\u003cstring\u003e","code":"\u003cstring\u003e"},"note":[{"text":"\u003cstring\u003e"}],"explanation":{"reason":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}]},"reaction":[{"date":"\u003cstring\u003e","reported":"\u003cboolean\u003e","detail":{"reference":"\u003cstring\u003e"}}],"vaccinationProtocol":[{"doseSequence":"\u003cnumber\u003e","description":"\u003cstring\u003e","series":"\u003cstring\u003e","seriesDoses":"\u003cnumber\u003e","authority":{"reference":"\u003cstring\u003e"},"targetDisease":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"doseStatus":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"doseStatusReason":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}}]},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"\u003cstring\u003e","date":"\u003cstring\u003e","vaccineCode":{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"text":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"wasNotGiven":"\u003cboolean\u003e","reported":"\u003cboolean\u003e","performer":{"reference":"\u003cstring\u003e"},"requester":{"reference":"\u003cstring\u003e"},"encounter":{"reference":"\u003cstring\u003e"},"manufacturer":{"reference":"\u003cstring\u003e"},"location":{"reference":"\u003cstring\u003e"},"lotNumber":"\u003cstring\u003e","expirationDate":"\u003cstring\u003e","site":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"route":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"doseQuantity":{"value":"\u003cnumber\u003e","system":"\u003cstring\u003e","code":"\u003cstring\u003e"},"note":[{"text":"\u003cstring\u003e"}],"explanation":{"reason":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}]},"reaction":[{"date":"\u003cstring\u003e","reported":"\u003cboolean\u003e","detail":{"reference":"\u003cstring\u003e"}}],"vaccinationProtocol":[{"doseSequence":"\u003cnumber\u003e","description":"\u003cstring\u003e","series":"\u003cstring\u003e","seriesDoses":"\u003cnumber\u003e","authority":{"reference":"\u003cstring\u003e"},"targetDisease":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"doseStatus":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"doseStatusReason":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}}]}]