vision prescriptions

Create Vision Prescription

post
/organizations/{organizationId}/fhir/3/VisionPrescription

An authorization for the supply of glasses and/or contact lenses to a patient.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringVisionPrescriptionThis is a VisionPrescription resource
identifierarray(Identifier)Business identifier which may be used by other parties to reference or identify the prescription.
statusstringThe status of the resource instance.
patientReferenceA link to a resource representing the person to whom the vision products will be supplied.
encounterReferenceA link to a resource that identifies the particular occurrence of contact between patient and health care provider.
dateWrittenstringThe date (and perhaps time) when the prescription was written.
prescriberReferenceThe healthcare professional responsible for authorizing the prescription.
reasonCodeableConceptCodeableConceptCan be the reason or the indication for writing the prescription.
reasonReferenceReferenceCan be the reason or the indication for writing the prescription.
dispensearray(VisionPrescription_Dispense)Deals with details of the dispense part of the supply specification.

Response

Patch Vision Prescription

patch
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}

An authorization for the supply of glasses and/or contact lenses to a patient.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringVisionPrescriptionThis is a VisionPrescription resource
identifierarray(Identifier)Business identifier which may be used by other parties to reference or identify the prescription.
statusstringThe status of the resource instance.
patientReferenceA link to a resource representing the person to whom the vision products will be supplied.
encounterReferenceA link to a resource that identifies the particular occurrence of contact between patient and health care provider.
dateWrittenstringThe date (and perhaps time) when the prescription was written.
prescriberReferenceThe healthcare professional responsible for authorizing the prescription.
reasonCodeableConceptCodeableConceptCan be the reason or the indication for writing the prescription.
reasonReferenceReferenceCan be the reason or the indication for writing the prescription.
dispensearray(VisionPrescription_Dispense)Deals with details of the dispense part of the supply specification.

Response

Read Vision Prescription

get
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Vision Prescription

get
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Vision Prescription

get
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Vision Prescription

delete
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Vision Prescription

get
/organizations/{organizationId}/fhir/3/VisionPrescription

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datewrittenstring
encounterstring
identifierstring
patientstring
prescriberstring

Params

organizationId*string|stringid|slug

Response

Search History Vision Prescription

get
/organizations/{organizationId}/fhir/3/VisionPrescription/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Vision Prescription

post
/organizations/{organizationId}/fhir/3/VisionPrescription/_search

An authorization for the supply of glasses and/or contact lenses to a patient.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datewrittenstring
encounterstring
identifierstring
patientstring
prescriberstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringVisionPrescriptionThis is a VisionPrescription resource
identifierarray(Identifier)Business identifier which may be used by other parties to reference or identify the prescription.
statusstringThe status of the resource instance.
patientReferenceA link to a resource representing the person to whom the vision products will be supplied.
encounterReferenceA link to a resource that identifies the particular occurrence of contact between patient and health care provider.
dateWrittenstringThe date (and perhaps time) when the prescription was written.
prescriberReferenceThe healthcare professional responsible for authorizing the prescription.
reasonCodeableConceptCodeableConceptCan be the reason or the indication for writing the prescription.
reasonReferenceReferenceCan be the reason or the indication for writing the prescription.
dispensearray(VisionPrescription_Dispense)Deals with details of the dispense part of the supply specification.

Response

Update Vision Prescription

put
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}

An authorization for the supply of glasses and/or contact lenses to a patient.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringVisionPrescriptionThis is a VisionPrescription resource
identifierarray(Identifier)Business identifier which may be used by other parties to reference or identify the prescription.
statusstringThe status of the resource instance.
patientReferenceA link to a resource representing the person to whom the vision products will be supplied.
encounterReferenceA link to a resource that identifies the particular occurrence of contact between patient and health care provider.
dateWrittenstringThe date (and perhaps time) when the prescription was written.
prescriberReferenceThe healthcare professional responsible for authorizing the prescription.
reasonCodeableConceptCodeableConceptCan be the reason or the indication for writing the prescription.
reasonReferenceReferenceCan be the reason or the indication for writing the prescription.
dispensearray(VisionPrescription_Dispense)Deals with details of the dispense part of the supply specification.

Response