2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 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

4.30 Resource VisionPrescription - Content

This resource maintained by the Financial Management Work Group

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

4.30.1 Scope and Usage

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

4.30.2 Boundaries and Relationships

This resource is referenced by [VisionClaim]

4.30.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VisionPrescription DomainResourcePrescription for Vision correction products for a patient
... identifier 0..*IdentifierBusiness identifier
... dateWritten 0..1dateTimeWhen prescription was authorized
... patient 0..1PatientWho prescription is for
... prescriber 0..1PractitionerWho authorizes the Vision product
... encounter 0..1EncounterCreated during encounter / admission / stay
... reason[x] Reason or indication for writing the prescription
.... reasonCodeableConcept0..1CodeableConcept
.... reasonReference0..1Condition
... dispense 0..*ElementVision supply authorization
.... product 1..1CodingProduct to be supplied
VisionProduct (Example)
.... eye 0..1coderight | left
VisionEyes (Required)
.... sphere 0..1decimalLens sphere
.... cylinder 0..1decimalLens cylinder
.... axis 0..1integerLens axis
.... prism 0..1decimalLens prism
.... base 0..1codeup | down | in | out
VisionBase (Required)
.... add 0..1decimalLens add
.... power 0..1decimalContact Lens power
.... backCurve 0..1decimalContact lens back curvature
.... diameter 0..1decimalContact Lens diameter
.... duration 0..1QuantityLens wear duration
.... color 0..1stringLens add
.... brand 0..1stringLens add
.... notes 0..1stringNotes for coatings

UML Diagram

VisionPrescription (DomainResource)Business identifier which may be used by other parties to reference or identify the prescriptionidentifier : Identifier 0..*The date (and perhaps time) when the prescription was writtendateWritten : dateTime 0..1A link to a resource representing the person to whom the Vision products will be suppliedpatient : Reference(Patient) 0..1The healthcare professional responsible for authorizing the prescriptionprescriber : Reference(Practitioner) 0..1A link to a resource that identifies the particular occurrence of contact between patient and health care providerencounter : Reference(Encounter) 0..1Can be the reason or the indication for writing the prescriptionreason[x] : CodeableConcept|Reference(Condition) 0..1DispenseIdentifies the type of Vision correction product which is required for the patientproduct : Coding 1..1 « (A coded concept describing the Vision products.VisionProduct) »The eye for which the lens applieseye : code 0..1 « A coded concept listing the eye codes.VisionEyes »Lens power measured in diopters (0.25 units)sphere : decimal 0..1Power adjustment for astigmatism measured in diopters (0.25 units)cylinder : decimal 0..1Adjustment for astigmatism measured in integer degreesaxis : integer 0..1Amount of prism to compensate for eye alignment in fractional unitsprism : decimal 0..1The relative base, or reference lens edge, for the prismbase : code 0..1 « A coded concept listing the base codes.VisionBase »Power adjustment for multifocal lenses measured in diopters (0.25 units)add : decimal 0..1Contact lens power measured in diopters (0.25 units)power : decimal 0..1Back Curvature measured in millimetersbackCurve : decimal 0..1Contact lens diameter measured in millimetersdiameter : decimal 0..1The recommended maximum wear period for the lensduration : Quantity 0..1Special color or patterncolor : string 0..1Brand recommendations or restrictionsbrand : string 0..1Notes for special requirements such as coatings and lens materialsnotes : string 0..1Deals with details of the dispense part of the supply specificationdispense0..*

XML Template

<VisionPrescription xmlns="http://hl7.org/fhir"> doco
 <!-- 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 Lens wear duration --></duration>
  <color value="[string]"/><!-- 0..1 Lens add -->
  <brand value="[string]"/><!-- 0..1 Lens add -->
  <notes value="[string]"/><!-- 0..1 Notes for coatings -->
 </dispense>
</VisionPrescription>

JSON Template

{doco
  "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 }, // Lens wear duration
    "color" : "<string>", // Lens add
    "brand" : "<string>", // Lens add
    "notes" : "<string>" // Notes for coatings
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VisionPrescription DomainResourcePrescription for Vision correction products for a patient
... identifier 0..*IdentifierBusiness identifier
... dateWritten 0..1dateTimeWhen prescription was authorized
... patient 0..1PatientWho prescription is for
... prescriber 0..1PractitionerWho authorizes the Vision product
... encounter 0..1EncounterCreated during encounter / admission / stay
... reason[x] Reason or indication for writing the prescription
.... reasonCodeableConcept0..1CodeableConcept
.... reasonReference0..1Condition
... dispense 0..*ElementVision supply authorization
.... product 1..1CodingProduct to be supplied
VisionProduct (Example)
.... eye 0..1coderight | left
VisionEyes (Required)
.... sphere 0..1decimalLens sphere
.... cylinder 0..1decimalLens cylinder
.... axis 0..1integerLens axis
.... prism 0..1decimalLens prism
.... base 0..1codeup | down | in | out
VisionBase (Required)
.... add 0..1decimalLens add
.... power 0..1decimalContact Lens power
.... backCurve 0..1decimalContact lens back curvature
.... diameter 0..1decimalContact Lens diameter
.... duration 0..1QuantityLens wear duration
.... color 0..1stringLens add
.... brand 0..1stringLens add
.... notes 0..1stringNotes for coatings

UML Diagram

VisionPrescription (DomainResource)Business identifier which may be used by other parties to reference or identify the prescriptionidentifier : Identifier 0..*The date (and perhaps time) when the prescription was writtendateWritten : dateTime 0..1A link to a resource representing the person to whom the Vision products will be suppliedpatient : Reference(Patient) 0..1The healthcare professional responsible for authorizing the prescriptionprescriber : Reference(Practitioner) 0..1A link to a resource that identifies the particular occurrence of contact between patient and health care providerencounter : Reference(Encounter) 0..1Can be the reason or the indication for writing the prescriptionreason[x] : CodeableConcept|Reference(Condition) 0..1DispenseIdentifies the type of Vision correction product which is required for the patientproduct : Coding 1..1 « (A coded concept describing the Vision products.VisionProduct) »The eye for which the lens applieseye : code 0..1 « A coded concept listing the eye codes.VisionEyes »Lens power measured in diopters (0.25 units)sphere : decimal 0..1Power adjustment for astigmatism measured in diopters (0.25 units)cylinder : decimal 0..1Adjustment for astigmatism measured in integer degreesaxis : integer 0..1Amount of prism to compensate for eye alignment in fractional unitsprism : decimal 0..1The relative base, or reference lens edge, for the prismbase : code 0..1 « A coded concept listing the base codes.VisionBase »Power adjustment for multifocal lenses measured in diopters (0.25 units)add : decimal 0..1Contact lens power measured in diopters (0.25 units)power : decimal 0..1Back Curvature measured in millimetersbackCurve : decimal 0..1Contact lens diameter measured in millimetersdiameter : decimal 0..1The recommended maximum wear period for the lensduration : Quantity 0..1Special color or patterncolor : string 0..1Brand recommendations or restrictionsbrand : string 0..1Notes for special requirements such as coatings and lens materialsnotes : string 0..1Deals with details of the dispense part of the supply specificationdispense0..*

XML Template

<VisionPrescription xmlns="http://hl7.org/fhir"> doco
 <!-- 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 Lens wear duration --></duration>
  <color value="[string]"/><!-- 0..1 Lens add -->
  <brand value="[string]"/><!-- 0..1 Lens add -->
  <notes value="[string]"/><!-- 0..1 Notes for coatings -->
 </dispense>
</VisionPrescription>

JSON Template

{doco
  "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 }, // Lens wear duration
    "color" : "<string>", // Lens add
    "brand" : "<string>", // Lens add
    "notes" : "<string>" // Notes for coatings
  }]
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.30.3.1 Terminology Bindings

PathDefinitionTypeReference
VisionPrescription.dispense.product A coded concept describing the Vision products.Examplehttp://hl7.org/fhir/vs/vision-product
VisionPrescription.dispense.eye A coded concept listing the eye codes.Fixedhttp://hl7.org/fhir/eye-codes
VisionPrescription.dispense.base A coded concept listing the base codes.Fixedhttp://hl7.org/fhir/base-codes

4.30.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.

NameTypeDescriptionPaths
datewrittendateReturn prescriptions written on this dateVisionPrescription.dateWritten
encounterreferenceReturn prescriptions with this encounter identityVisionPrescription.encounter
(Encounter)
identifiertokenReturn prescriptions with this external identityVisionPrescription.identifier
patientreferenceThe identity of a patient to list dispenses forVisionPrescription.patient
(Patient)