This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

12.5 Resource VisionPrescription - Content

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.

12.5.1 Scope and Usage

This resource covers all prescriptions for glasses and contact lenses for a patient.

12.5.2 Boundaries and Relationships

This resource is referenced by CarePlan, Claim, ClinicalImpression and ExplanationOfBenefit

Structure

Name	Flags	Card.	Type	Description & Constraints
VisionPrescription	Σ		DomainResource	Prescription for vision correction products for a patient
identifier	Σ	0..*	Identifier	Business identifier
dateWritten	Σ	0..1	dateTime	When prescription was authorized
patient	Σ	0..1	Reference(Patient)	Who prescription is for
prescriber	Σ	0..1	Reference(Practitioner)	Who authorizes the vision product
encounter	Σ	0..1	Reference(Encounter)	Created during encounter / admission / stay
reason[x]	Σ	0..1		Reason or indication for writing the prescription
reasonCodeableConcept			CodeableConcept
reasonReference			Reference(Condition)
dispense	Σ	0..*	BackboneElement	Vision supply authorization
product	Σ	1..1	Coding	Product to be supplied Example Vision Prescription Product Codes (Example)
eye	Σ	0..1	code	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	code	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
notes	Σ	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>
 <dateWritten value="[dateTime]"/><!-- 0..1 When prescription was authorized -->
 <patient><!-- 0..1 Reference(Patient) Who prescription is for --></patient>
 <prescriber><!-- 0..1 Reference(Practitioner) Who authorizes the vision product --></prescriber>
 <encounter><!-- 0..1 Reference(Encounter) Created during encounter / admission / stay --></encounter>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Condition) Reason or indication for writing the prescription --></reason[x]>
 <dispense>  <!-- 0..* Vision supply authorization -->
  <product><!-- 1..1 Coding Product to be supplied --></product>
  <eye value="[code]"/><!-- 0..1 right | left -->
  <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 value="[code]"/><!-- 0..1 up | down | in | out -->
  <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 -->
  <notes 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
  "dateWritten" : "<dateTime>", // When prescription was authorized
  "patient" : { Reference(Patient) }, // Who prescription is for
  "prescriber" : { Reference(Practitioner) }, // Who authorizes the vision product
  "encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
  // reason[x]: Reason or indication for writing the prescription. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Condition) },
  "dispense" : [{ // Vision supply authorization
    "product" : { Coding }, // R!  Product to be supplied
    "eye" : "<code>", // right | left
    "sphere" : <decimal>, // Lens sphere
    "cylinder" : <decimal>, // Lens cylinder
    "axis" : <integer>, // Lens axis
    "prism" : <decimal>, // Lens prism
    "base" : "<code>", // 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
    "notes" : "<string>" // Notes for coatings
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:VisionPrescription;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:VisionPrescription.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:VisionPrescription.dateWritten [ dateTime ]; # 0..1 When prescription was authorized
  fhir:VisionPrescription.patient [ Reference(Patient) ]; # 0..1 Who prescription is for
  fhir:VisionPrescription.prescriber [ Reference(Practitioner) ]; # 0..1 Who authorizes the vision product
  fhir:VisionPrescription.encounter [ Reference(Encounter) ]; # 0..1 Created during encounter / admission / stay
  # VisionPrescription.reason[x] : 0..1 Reason or indication for writing the prescription. One of these 2
    fhir:VisionPrescription.reasonCodeableConcept [ CodeableConcept ]
    fhir:VisionPrescription.reasonReference [ Reference(Condition) ]
  fhir:VisionPrescription.dispense [ # 0..* Vision supply authorization
    fhir:VisionPrescription.dispense.product [ Coding ]; # 1..1 Product to be supplied
    fhir:VisionPrescription.dispense.eye [ code ]; # 0..1 right | left
    fhir:VisionPrescription.dispense.sphere [ decimal ]; # 0..1 Lens sphere
    fhir:VisionPrescription.dispense.cylinder [ decimal ]; # 0..1 Lens cylinder
    fhir:VisionPrescription.dispense.axis [ integer ]; # 0..1 Lens axis
    fhir:VisionPrescription.dispense.prism [ decimal ]; # 0..1 Lens prism
    fhir:VisionPrescription.dispense.base [ code ]; # 0..1 up | down | in | out
    fhir:VisionPrescription.dispense.add [ decimal ]; # 0..1 Lens add
    fhir:VisionPrescription.dispense.power [ decimal ]; # 0..1 Contact lens power
    fhir:VisionPrescription.dispense.backCurve [ decimal ]; # 0..1 Contact lens back curvature
    fhir:VisionPrescription.dispense.diameter [ decimal ]; # 0..1 Contact lens diameter
    fhir:VisionPrescription.dispense.duration [ Quantity(SimpleQuantity) ]; # 0..1 Lens wear duration
    fhir:VisionPrescription.dispense.color [ string ]; # 0..1 Color required
    fhir:VisionPrescription.dispense.brand [ string ]; # 0..1 Brand required
    fhir:VisionPrescription.dispense.notes [ string ]; # 0..1 Notes for coatings
  ], ...;
]

Changes since DSTU2

VisionPrescription

No Changes

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
dateWritten	Σ	0..1	dateTime	When prescription was authorized
patient	Σ	0..1	Reference(Patient)	Who prescription is for
prescriber	Σ	0..1	Reference(Practitioner)	Who authorizes the vision product
encounter	Σ	0..1	Reference(Encounter)	Created during encounter / admission / stay
reason[x]	Σ	0..1		Reason or indication for writing the prescription
reasonCodeableConcept			CodeableConcept
reasonReference			Reference(Condition)
dispense	Σ	0..*	BackboneElement	Vision supply authorization
product	Σ	1..1	Coding	Product to be supplied Example Vision Prescription Product Codes (Example)
eye	Σ	0..1	code	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	code	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
notes	Σ	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>
 <dateWritten value="[dateTime]"/><!-- 0..1 When prescription was authorized -->
 <patient><!-- 0..1 Reference(Patient) Who prescription is for --></patient>
 <prescriber><!-- 0..1 Reference(Practitioner) Who authorizes the vision product --></prescriber>
 <encounter><!-- 0..1 Reference(Encounter) Created during encounter / admission / stay --></encounter>
 <reason[x]><!-- 0..1 CodeableConcept|Reference(Condition) Reason or indication for writing the prescription --></reason[x]>
 <dispense>  <!-- 0..* Vision supply authorization -->
  <product><!-- 1..1 Coding Product to be supplied --></product>
  <eye value="[code]"/><!-- 0..1 right | left -->
  <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 value="[code]"/><!-- 0..1 up | down | in | out -->
  <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 -->
  <notes 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
  "dateWritten" : "<dateTime>", // When prescription was authorized
  "patient" : { Reference(Patient) }, // Who prescription is for
  "prescriber" : { Reference(Practitioner) }, // Who authorizes the vision product
  "encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
  // reason[x]: Reason or indication for writing the prescription. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Condition) },
  "dispense" : [{ // Vision supply authorization
    "product" : { Coding }, // R!  Product to be supplied
    "eye" : "<code>", // right | left
    "sphere" : <decimal>, // Lens sphere
    "cylinder" : <decimal>, // Lens cylinder
    "axis" : <integer>, // Lens axis
    "prism" : <decimal>, // Lens prism
    "base" : "<code>", // 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
    "notes" : "<string>" // Notes for coatings
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:VisionPrescription;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:VisionPrescription.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:VisionPrescription.dateWritten [ dateTime ]; # 0..1 When prescription was authorized
  fhir:VisionPrescription.patient [ Reference(Patient) ]; # 0..1 Who prescription is for
  fhir:VisionPrescription.prescriber [ Reference(Practitioner) ]; # 0..1 Who authorizes the vision product
  fhir:VisionPrescription.encounter [ Reference(Encounter) ]; # 0..1 Created during encounter / admission / stay
  # VisionPrescription.reason[x] : 0..1 Reason or indication for writing the prescription. One of these 2
    fhir:VisionPrescription.reasonCodeableConcept [ CodeableConcept ]
    fhir:VisionPrescription.reasonReference [ Reference(Condition) ]
  fhir:VisionPrescription.dispense [ # 0..* Vision supply authorization
    fhir:VisionPrescription.dispense.product [ Coding ]; # 1..1 Product to be supplied
    fhir:VisionPrescription.dispense.eye [ code ]; # 0..1 right | left
    fhir:VisionPrescription.dispense.sphere [ decimal ]; # 0..1 Lens sphere
    fhir:VisionPrescription.dispense.cylinder [ decimal ]; # 0..1 Lens cylinder
    fhir:VisionPrescription.dispense.axis [ integer ]; # 0..1 Lens axis
    fhir:VisionPrescription.dispense.prism [ decimal ]; # 0..1 Lens prism
    fhir:VisionPrescription.dispense.base [ code ]; # 0..1 up | down | in | out
    fhir:VisionPrescription.dispense.add [ decimal ]; # 0..1 Lens add
    fhir:VisionPrescription.dispense.power [ decimal ]; # 0..1 Contact lens power
    fhir:VisionPrescription.dispense.backCurve [ decimal ]; # 0..1 Contact lens back curvature
    fhir:VisionPrescription.dispense.diameter [ decimal ]; # 0..1 Contact lens diameter
    fhir:VisionPrescription.dispense.duration [ Quantity(SimpleQuantity) ]; # 0..1 Lens wear duration
    fhir:VisionPrescription.dispense.color [ string ]; # 0..1 Color required
    fhir:VisionPrescription.dispense.brand [ string ]; # 0..1 Brand required
    fhir:VisionPrescription.dispense.notes [ string ]; # 0..1 Notes for coatings
  ], ...;
]

Changes since DSTU2

VisionPrescription

No Changes

See the Full Difference for further information

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

12.5.3.1 Terminology Bindings

Path	Definition	Type	Reference
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

Path

Definition

Type

Reference

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

12.5.4 Search Parameters

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
datewritten	date	Return prescriptions written on this date	VisionPrescription.dateWritten
encounter	reference	Return prescriptions with this encounter identifier	VisionPrescription.encounter (Encounter)
identifier	token	Return prescriptions with this external identifier	VisionPrescription.identifier
patient	reference	The identity of a patient to list dispenses for	VisionPrescription.patient (Patient)
prescriber	reference	Who authorizes the vision product	VisionPrescription.prescriber (Practitioner)