Test Sandbox APIs
API Reference
Capability Statement
Immunization
The Immunization API enables Humana members to exchange a list of their previous immunizations and vaccines with third party applications. This API conforms to the R4 FHIR standard and the US Core STU3 Implementation Guide.
URL
Headers
ACCEPT | application/json |
AUTHORIZATION | Bearer {ACCESS_TOKEN} |
Sample Request
curl -X GET \
https://sandbox-fhir.humana.com/api/Immunization \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {your access token}' \
curl -X GET \
https://fhir.humana.com/api/Immunization \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {your access token}' \
Sample Response
{
"resourceType": "Bundle",
"type": "searchset",
"timestamp": "2025-01-15T16:43:17.150+00:00",
"meta": {
"lastUpdated": "2025-01-15T16:43:17.150+00:00",
"versionId": "57fa6a8d-3281-4389-a686-a134eb27c968"
},
"entry": [
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/8cc93df9dbaedd7a24ab1e4d8224c6524c81994c04dd442285a7ac10a7eec7f0",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "8cc93df9dbaedd7a24ab1e4d8224c6524c81994c04dd442285a7ac10a7eec7f0",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "115",
"display": "Tdap"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2022-03-21",
"primarySource": true,
"meta": {
"versionId": "c83f3e56-0919-4d75-a9fd-d2709b5e55db",
"lastUpdated": "2025-01-14T21:49:13.769+00:00"
}
}
},
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/a4274de4ec78c2c3d828a820e530cb7bda353a6bdff96ca790e7a5fe206c1856",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "a4274de4ec78c2c3d828a820e530cb7bda353a6bdff96ca790e7a5fe206c1856",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "150",
"display": "influenza, injectable, quadrivalent, preservative free"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2017-11-10",
"primarySource": true,
"meta": {
"versionId": "b4843f9f-f59c-4d93-abd7-d96ee7a14dbd",
"lastUpdated": "2025-01-14T21:49:13.782+00:00"
}
}
},
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/97e593f6f79867893c4886e0464af643701a9c58cf76665297198b5241b5a64d",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "97e593f6f79867893c4886e0464af643701a9c58cf76665297198b5241b5a64d",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "10",
"display": "IPV"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2013-12-12",
"primarySource": true,
"meta": {
"versionId": "7a70fd53-ce39-4aac-a417-6486e8ce8e25",
"lastUpdated": "2025-01-14T21:49:13.774+00:00"
}
}
},
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/c0b3d03867835eb0aa07e2ba615a61f2b19e1dc9ac9f973fcb007c40d9f28547",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "c0b3d03867835eb0aa07e2ba615a61f2b19e1dc9ac9f973fcb007c40d9f28547",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "208",
"display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2021-08-21",
"primarySource": true,
"meta": {
"versionId": "34fd6b12-46dd-4cd0-b54f-de153c37c2fc",
"lastUpdated": "2025-01-14T21:49:14.380+00:00"
}
}
},
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/bedc2b4cdacc37fe20980b49f4d033102d5e8562a8bdfba5732ea17d72be280f",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "bedc2b4cdacc37fe20980b49f4d033102d5e8562a8bdfba5732ea17d72be280f",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "208",
"display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2021-07-31",
"primarySource": true,
"meta": {
"versionId": "3225e785-a5c3-4f83-92b1-5a60700f49e4",
"lastUpdated": "2025-01-14T21:49:14.401+00:00"
}
}
},
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/ac8041f1aae51603630fdf9de8ceac21150168ae12dae7d5f24130eeaf185a02",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "ac8041f1aae51603630fdf9de8ceac21150168ae12dae7d5f24130eeaf185a02",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "83",
"display": "Hep A, ped/adol, 2 dose"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2010-07-13",
"primarySource": true,
"meta": {
"versionId": "2f0fb2e6-fa58-4dc5-ba37-4f69c54cbc4b",
"lastUpdated": "2025-01-14T21:49:14.446+00:00"
}
}
},
{
"fullUrl": "https://sandbox-fhir.humana.com/Immunization/d9e5f7969d084786a3088d71e7238a4daf91ccdeb56dbde7d25e298b926aa1ab",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Immunization",
"id": "d9e5f7969d084786a3088d71e7238a4daf91ccdeb56dbde7d25e298b926aa1ab",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "208",
"display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
}
]
},
"patient": {
"reference": "Patient/5a357166754b59777137634248494434654c336d68773d3d"
},
"occurrenceDateTime": "2022-02-08",
"primarySource": true,
"meta": {
"versionId": "0f7735a4-5cdc-445e-a726-8134402c40b8",
"lastUpdated": "2025-01-14T21:49:14.463+00:00"
}
}
}
],
"total": 7,
"link": [
{
"relation": "self",
"url": "https://sandbox-fhir.humana.com/Immunization?patient=5a357166754b59777137634248494434654c336d68773d3d&_total=accurate&_count=10&_skip=0"
}
],
"id": "f715c740-14ae-45b7-8ab6-f00457cea238"
}