VisionPrescription - FHIR Resource (r4)

This VisionPrescription Resource uses the FHIR API standard for access and structure.

Validate an VisionPrescription FHIR Resource (r4)

VisionPrescription Attributes

AttributeField is listTypeDescription

Description: Business Identifier for vision prescription

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://www.happysight.com/prescription",
    "value": "15013"
  }
]

Learn more about the (VisionPrescription) identifier FHIR attribute

Description: active | cancelled | draft | entered-in-error

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "active"

Learn more about the (VisionPrescription) status FHIR attribute

Description: Response creation date

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"created": "2014-06-15"

Learn more about the (VisionPrescription) created FHIR attribute

Description: Who prescription is for

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"patient": {
  "reference": "Patient/example"
}

Learn more about the (VisionPrescription) patient FHIR attribute

Description: Created during encounter / admission / stay

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"encounter":

Learn more about the (VisionPrescription) encounter FHIR attribute

Description: When prescription was authorized

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"dateWritten": "2014-06-15"

Learn more about the (VisionPrescription) dateWritten FHIR attribute

Description: Who authorized the vision prescription

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"prescriber": {
  "reference": "Practitioner/example"
}

Learn more about the (VisionPrescription) prescriber FHIR attribute

Description: Vision lens authorization

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"lensSpecification": [
  {
    "product": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/ex-visionprescriptionproduct",
          "code": "lens"
        }
      ]
    },
    "eye": "right",
    "sphere": -2,
    "prism": [
      {
        "amount": 0.5,
        "base": "down"
      }
    ],
    "add": 2
  },
  {
    "product": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/ex-visionprescriptionproduct",
          "code": "lens"
        }
      ]
    },
    "eye": "left",
    "sphere": -1,
    "cylinder": -0.5,
    "axis": 180,
    "prism": [
      {
        "amount": 0.5,
        "base": "up"
      }
    ],
    "add": 2
  }
]

Learn more about the (VisionPrescription) lensSpecification FHIR attribute

VisionPrescription Example

{
  "resourceType": "VisionPrescription",
  "id": "33123",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>OD -2.00 SPH         +2.00 add    0.5 p.d. BD</p>\n\t\t\t<p>OS -1.00 -0.50 x 180 +2.00 add    0.5 p.d. BU</p>\n\t\t</div>"
  },
  "identifier": [
    {
      "system": "http://www.happysight.com/prescription",
      "value": "15013"
    }
  ],
  "status": "active",
  "created": "2014-06-15",
  "patient": {
    "reference": "Patient/example"
  },
  "dateWritten": "2014-06-15",
  "prescriber": {
    "reference": "Practitioner/example"
  },
  "lensSpecification": [
    {
      "product": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/ex-visionprescriptionproduct",
            "code": "lens"
          }
        ]
      },
      "eye": "right",
      "sphere": -2,
      "prism": [
        {
          "amount": 0.5,
          "base": "down"
        }
      ],
      "add": 2
    },
    {
      "product": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/ex-visionprescriptionproduct",
            "code": "lens"
          }
        ]
      },
      "eye": "left",
      "sphere": -1,
      "cylinder": -0.5,
      "axis": 180,
      "prism": [
        {
          "amount": 0.5,
          "base": "up"
        }
      ],
      "add": 2
    }
  ]
}

VisionPrescription Structure

{
  "resourceType" : "VisionPrescription",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for vision prescription
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "created" : "<dateTime>", // R!  Response creation date
  "patient" : { Reference(Patient) }, // R!  Who prescription is for
  "encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
  "dateWritten" : "<dateTime>", // R!  When prescription was authorized
  "prescriber" : { Reference(Practitioner|PractitionerRole) }, // R!  Who authorized the vision prescription
  "lensSpecification" : [{ // R!  Vision lens authorization
    "product" : { CodeableConcept }, // R!  Product to be supplied
    "eye" : "<code>", // R!  right | left
    "sphere" : <decimal>, // Power of the lens
    "cylinder" : <decimal>, // Lens power for astigmatism
    "axis" : <integer>, // Lens meridian which contain no power for astigmatism
    "prism" : [{ // Eye alignment compensation
      "amount" : <decimal>, // R!  Amount of adjustment
      "base" : "<code>" // R!  up | down | in | out
    }],
    "add" : <decimal>, // Added power for multifocal levels
    "power" : <decimal>, // Contact lens power
    "backCurve" : <decimal>, // Contact lens back curvature
    "diameter" : <decimal>, // Contact lens diameter
    "duration" : { Quantity(SimpleQuantity) }, // Lens wear duration
    "color" : "<string>", // Color required
    "brand" : "<string>", // Brand required
    "note" : [{ Annotation }] // Notes for coatings
  }]
}

VisionPrescription Search Parameters

The following search parameters can be used to query VisionPrescription resources. Just submit them like so:

https://api.1up.health/fhir/r4/VisionPrescription?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`datewritten`	`date`	`dateWritten`
`encounter`	`reference`	`encounter`
`identifier`	`text`	`identifier`
`patient`	`reference`	`patient`
`prescriber`	`reference`	`prescriber`
`status`	`text`	`status`