Immunization

get

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Query parameters

_prettybooleanOptional

_summarystringOptional

Responses

200

FHIR Resource Bundle

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Bundle

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

get/Immunization/{id}/_history

HTTPcURLJavaScriptPython

GET /fhir/Immunization/{id}/_history HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{}

get

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Query parameters

_prettybooleanOptional

_summarystringOptional

Responses

200

FHIR Resource Immunization

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

get/Immunization/{id}

HTTPcURLJavaScriptPython

GET /fhir/Immunization/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{}

put

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Body

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

Responses

200

FHIR Resource Immunization

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

put/Immunization/{id}

HTTPcURLJavaScriptPython

PUT /fhir/Immunization/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/fhir+json
Accept: */*
Content-Length: 2

{}

application/fhir+jsonapplication/fhir+xml

{}

delete

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Responses

200

FHIR Resource Immunization

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

delete/Immunization/{id}

HTTPcURLJavaScriptPython

DELETE /fhir/Immunization/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{}

get

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Query parameters

vaccine-codestringOptional

dose-sequencenumberOptional

datestringOptional

patientstringOptional

patient.genderstringOptional

patient.namestringOptional

patient.birthDatestringOptional

patient.location.identifierstringOptional

in-catchmentstringOptional

is-outreachstringOptional

is-backEntrystringOptional

locationstringOptional

location.namestringOptional

location.identifierstringOptional

_countnumberOptional

_lastUpdatedstringOptional

_formatstringOptional

_offsetnumberOptional

_pagenumberOptional

_stateidstringOptional

_idstringOptional

_prettystringOptional

_summarystringOptional

_totalstringOptional

Responses

200

FHIR Resource Bundle

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Bundle

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

get/Immunization

HTTPcURLJavaScriptPython

GET /fhir/Immunization HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{}

post

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Body

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

Responses

201

FHIR Resource Immunization

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

post/Immunization

HTTPcURLJavaScriptPython

POST /fhir/Immunization HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/fhir+json
Accept: */*
Content-Length: 2

{}

application/fhir+jsonapplication/fhir+xml

{}

get

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

versionIdstringOptional

Responses

200

FHIR Resource Immunization

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

get/Immunization/{id}/_history/{versionId}

HTTPcURLJavaScriptPython

GET /fhir/Immunization/{id}/_history/{versionId} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{}

post

Required scopes

This endpoint requires the following scopes:

• : Login

Authorizations

svc_auth

OAuth2passwordRequired

Token URL:

Body

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Parameters

Responses

200

FHIR Resource Immunization

application/fhir+jsonapplication/fhir+xml

objectOptional

FHIR Resource Immunization

500

FHIR Resource OperationOutcome

application/fhir+jsonapplication/fhir+xml

post/Immunization/$validate

HTTPcURLJavaScriptPython

POST /fhir/Immunization/$validate HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/fhir+json
Accept: */*
Content-Length: 2

{}

application/fhir+jsonapplication/fhir+xml

{}