STU3 Candidate
Clinical SummaryThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Financial Management Work Group | Maturity Level: 1 | Compartments: Encounter, Patient, Practitioner |
An authorization for the supply of glasses and/or contact lenses to a patient.
This resource covers all prescriptions for glasses and contact lenses for a patient.
This resource is referenced by CarePlan, Claim and ExplanationOfBenefit
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  VisionPrescription | DomainResource | Prescription for vision correction products for a patient | ||
  identifier | 0..* | Identifier | Business identifier | |
 status | ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) |
 patient | 0..1 | Reference(Patient) | Who prescription is for | |
| encounter | 0..1 | Reference(Encounter) | Created during encounter / admission / stay | |
| dateWritten | 0..1 | dateTime | When prescription was authorized | |
| prescriber | 0..1 | Reference(Practitioner) | Who authorizes the vision product | |
 reason[x] | 0..1 | Reason or indication for writing the prescription | ||
 reasonCodeableConcept | CodeableConcept | |||
 reasonReference | Reference(Condition) | |||
 dispense | 0..* | BackboneElement | Vision supply authorization | |
 product | 0..1 | CodeableConcept | Product to be supplied Example Vision Prescription Product Codes (Example) | |
| eye | 0..1 | CodeableConcept | right | left VisionEyes (Required) | |
| sphere | 0..1 | decimal | Lens sphere | |
| cylinder | 0..1 | decimal | Lens cylinder | |
| axis | 0..1 | integer | Lens axis | |
| prism | 0..1 | decimal | Lens prism | |
| base | 0..1 | CodeableConcept | up | down | in | out VisionBase (Required) | |
| add | 0..1 | decimal | Lens add | |
| power | 0..1 | decimal | Contact lens power | |
| backCurve | 0..1 | decimal | Contact lens back curvature | |
| diameter | 0..1 | decimal | Contact lens diameter | |
| duration | 0..1 | SimpleQuantity | Lens wear duration | |
| color | 0..1 | string | Color required | |
| brand | 0..1 | string | Brand required | |
| note | 0..1 | string | Notes for coatings | |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<VisionPrescription xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business identifier --></identifier> <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <patient><!-- 0..1 Reference(Patient) Who prescription is for --></patient> <encounter><!-- 0..1 Reference(Encounter) Created during encounter / admission / stay --></encounter> <dateWritten value="[dateTime]"/><!-- 0..1 When prescription was authorized --> <prescriber><!-- 0..1 Reference(Practitioner) Who authorizes the vision product --></prescriber> <reason[x]><!-- 0..1 CodeableConcept|Reference(Condition) Reason or indication for writing the prescription --></reason[x]> <dispense> <!-- 0..* Vision supply authorization --> <product><!-- 0..1 CodeableConcept Product to be supplied --></product> <eye><!-- 0..1 CodeableConcept right | left --></eye> <sphere value="[decimal]"/><!-- 0..1 Lens sphere --> <cylinder value="[decimal]"/><!-- 0..1 Lens cylinder --> <axis value="[integer]"/><!-- 0..1 Lens axis --> <prism value="[decimal]"/><!-- 0..1 Lens prism --> <base><!-- 0..1 CodeableConcept up | down | in | out --></base> <add value="[decimal]"/><!-- 0..1 Lens add --> <power value="[decimal]"/><!-- 0..1 Contact lens power --> <backCurve value="[decimal]"/><!-- 0..1 Contact lens back curvature --> <diameter value="[decimal]"/><!-- 0..1 Contact lens diameter --> <duration><!-- 0..1 Quantity(SimpleQuantity) Lens wear duration --></duration> <color value="[string]"/><!-- 0..1 Color required --> <brand value="[string]"/><!-- 0..1 Brand required --> <note value="[string]"/><!-- 0..1 Notes for coatings --> </dispense> </VisionPrescription>
JSON Template
{
"resourceType" : "VisionPrescription",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // active | cancelled | draft | entered-in-error
"patient" : { Reference(Patient) }, // Who prescription is for
"encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
"dateWritten" : "<dateTime>", // When prescription was authorized
"prescriber" : { Reference(Practitioner) }, // Who authorizes the vision product
// reason[x]: Reason or indication for writing the prescription. One of these 2:
"reasonCodeableConcept" : { CodeableConcept },
"reasonReference" : { Reference(Condition) },
"dispense" : [{ // Vision supply authorization
"product" : { CodeableConcept }, // Product to be supplied
"eye" : { CodeableConcept }, // right | left
"sphere" : <decimal>, // Lens sphere
"cylinder" : <decimal>, // Lens cylinder
"axis" : <integer>, // Lens axis
"prism" : <decimal>, // Lens prism
"base" : { CodeableConcept }, // up | down | in | out
"add" : <decimal>, // Lens add
"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" : "<string>" // Notes for coatings
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| VisionPrescription | |
| VisionPrescription.status | added Element |
| VisionPrescription.dispense.product |
Min Cardinality changed from 1 to 0 Type changed from Coding to CodeableConcept |
| VisionPrescription.dispense.eye | Type changed from code to CodeableConcept |
| VisionPrescription.dispense.base | Type changed from code to CodeableConcept |
| VisionPrescription.dispense.note | added Element |
| VisionPrescription.dispense.notes | deleted |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VisionPrescription | DomainResource | Prescription for vision correction products for a patient | ||
| identifier | 0..* | Identifier | Business identifier | |
| status | ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) |
| patient | 0..1 | Reference(Patient) | Who prescription is for | |
| encounter | 0..1 | Reference(Encounter) | Created during encounter / admission / stay | |
| dateWritten | 0..1 | dateTime | When prescription was authorized | |
| prescriber | 0..1 | Reference(Practitioner) | Who authorizes the vision product | |
| reason[x] | 0..1 | Reason or indication for writing the prescription | ||
| reasonCodeableConcept | CodeableConcept | |||
| reasonReference | Reference(Condition) | |||
| dispense | 0..* | BackboneElement | Vision supply authorization | |
| product | 0..1 | CodeableConcept | Product to be supplied Example Vision Prescription Product Codes (Example) | |
| eye | 0..1 | CodeableConcept | right | left VisionEyes (Required) | |
| sphere | 0..1 | decimal | Lens sphere | |
| cylinder | 0..1 | decimal | Lens cylinder | |
| axis | 0..1 | integer | Lens axis | |
| prism | 0..1 | decimal | Lens prism | |
| base | 0..1 | CodeableConcept | up | down | in | out VisionBase (Required) | |
| add | 0..1 | decimal | Lens add | |
| power | 0..1 | decimal | Contact lens power | |
| backCurve | 0..1 | decimal | Contact lens back curvature | |
| diameter | 0..1 | decimal | Contact lens diameter | |
| duration | 0..1 | SimpleQuantity | Lens wear duration | |
| color | 0..1 | string | Color required | |
| brand | 0..1 | string | Brand required | |
| note | 0..1 | string | Notes for coatings | |
| Documentation for this format | ||||
XML Template
<VisionPrescription xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "VisionPrescription",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // active | cancelled | draft | entered-in-error
"patient" : { Reference(Patient) }, // Who prescription is for
"encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
"dateWritten" : "<dateTime>", // When prescription was authorized
"prescriber" : { Reference(Practitioner) }, // Who authorizes the vision product
// reason[x]: Reason or indication for writing the prescription. One of these 2:
"reasonCodeableConcept" : { CodeableConcept },
"reasonReference" : { Reference(Condition) },
"dispense" : [{ // Vision supply authorization
"product" : { CodeableConcept }, // Product to be supplied
"eye" : { CodeableConcept }, // right | left
"sphere" : <decimal>, // Lens sphere
"cylinder" : <decimal>, // Lens cylinder
"axis" : <integer>, // Lens axis
"prism" : <decimal>, // Lens prism
"base" : { CodeableConcept }, // up | down | in | out
"add" : <decimal>, // Lens add
"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" : "<string>" // Notes for coatings
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| VisionPrescription | |
| VisionPrescription.status | added Element |
| VisionPrescription.dispense.product |
Min Cardinality changed from 1 to 0 Type changed from Coding to CodeableConcept |
| VisionPrescription.dispense.eye | Type changed from code to CodeableConcept |
| VisionPrescription.dispense.base | Type changed from code to CodeableConcept |
| VisionPrescription.dispense.note | added Element |
| VisionPrescription.dispense.notes | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),
| Path | Definition | Type | Reference |
|---|---|---|---|
| VisionPrescription.status | A code specifying the state of the resource instance. | Required | Financial Resource Status Codes |
| VisionPrescription.dispense.product | A coded concept describing the vision products. | Example | Example Vision Prescription Product Codes |
| VisionPrescription.dispense.eye | A coded concept listing the eye codes. | Required | VisionEyes |
| VisionPrescription.dispense.base | A coded concept listing the base codes. | Required | VisionBase |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths | In Common |
| datewritten | date | Return prescriptions written on this date | VisionPrescription.dateWritten | |
| encounter | reference | Return prescriptions with this encounter identifier | VisionPrescription.encounter (Encounter) | 12 Resources |
| identifier | token | Return prescriptions with this external identifier | VisionPrescription.identifier | 26 Resources |
| patient | reference | The identity of a patient to list dispenses for | VisionPrescription.patient (Patient) | 31 Resources |
| prescriber | reference | Who authorizes the vision product | VisionPrescription.prescriber (Practitioner) |
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:27+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change