DSTU2 STU 3 Ballot
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

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 . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

4.29 12.5 Resource VisionPrescription - Content Resource VisionPrescription - Content

An authorization for the supply of glasses and/or contact lenses to a patient.
Financial Management Financial Management Work Group Work Group Maturity Level : 0 Maturity Level : 1 Compartments : : Encounter , , Patient , , Practitioner

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

4.29.1 12.5.1 Scope and Usage Scope and Usage This resource covers all prescriptions for glasses and contact lenses for a patient.

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

4.29.2 12.5.2 Boundaries and Relationships Boundaries and Relationships This resource is referenced by

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

4.29.3 Resource Content 12.5.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . VisionPrescription Σ DomainResource Prescription for vision correction products for a patient Prescription for vision correction products for a patient
. . . identifier Σ 0..* Identifier Business identifier Business identifier
. . . dateWritten Σ 0..1 dateTime When prescription was authorized When prescription was authorized
. . . patient Σ 0..1 Reference ( Patient ) Who prescription is for Who prescription is for
. . . prescriber Σ 0..1 Reference ( Practitioner ) Who authorizes the vision product Who authorizes the vision product
. . . encounter Σ 0..1 Reference ( Encounter ) Created during encounter / admission / stay Created during encounter / admission / stay
. . . reason[x] Σ 0..1 Reason or indication for writing the prescription Reason or indication for writing the prescription
. . . . reasonCodeableConcept CodeableConcept
. . . reasonReference . reasonReference Reference ( Condition )
. . . dispense Σ 0..* BackboneElement Vision supply authorization Vision supply authorization
. . . . product Σ 1..1 Coding Product to be supplied Product to be supplied
Example Vision Prescription Product Codes ( Example Vision Prescription Product Codes ( Example )
. . . . eye Σ 0..1 code right | left right | left
VisionEyes ( ( Required )
. . . . sphere Σ 0..1 decimal Lens sphere Lens sphere
. . . . cylinder Σ 0..1 decimal Lens cylinder Lens cylinder
. . . . axis Σ 0..1 integer Lens axis Lens axis
. . . . prism Σ 0..1 decimal Lens prism Lens prism
. . . . base Σ 0..1 code up | down | in | out up | down | in | out
VisionBase ( ( Required )
. . . . add Σ 0..1 decimal Lens add Lens add
. . . . power Σ 0..1 decimal Contact lens power Contact lens power
. . . . backCurve Σ 0..1 decimal Contact lens back curvature Contact lens back curvature
. . . . diameter Σ 0..1 decimal Contact lens diameter Contact lens diameter
. . . . duration Σ 0..1 SimpleQuantity Lens wear duration Lens wear duration
. . . . color Σ 0..1 string Lens add Color required
. . . . brand Σ 0..1 string Lens add Brand required
. . . . notes Σ 0..1 string Notes for coatings Notes for coatings

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

VisionPrescription ( ( DomainResource ) Business identifier which may be used by other parties to reference or identify the prescription Business identifier which may be used by other parties to reference or identify the prescription identifier : : Identifier [0..*] [0..*] The date (and perhaps time) when the prescription was written The date (and perhaps time) when the prescription was written dateWritten : : dateTime [0..1] [0..1] A link to a resource representing the person to whom the vision products will be supplied A link to a resource representing the person to whom the vision products will be supplied patient : : Reference [0..1] « [0..1] « Patient » » The healthcare professional responsible for authorizing the prescription The healthcare professional responsible for authorizing the prescription prescriber : : Reference [0..1] « [0..1] « Practitioner » » A link to a resource that identifies the particular occurrence of contact between patient and health care provider A link to a resource that identifies the particular occurrence of contact between patient and health care provider encounter : : Reference [0..1] « [0..1] « Encounter » » Can be the reason or the indication for writing the prescription Can be the reason or the indication for writing the prescription reason[x] : : Type [0..1] « [0..1] « CodeableConcept | Reference ( Condition ) » ) » Dispense Identifies the type of vision correction product which is required for the patient Identifies the type of vision correction product which is required for the patient product : : Coding [1..1] « [1..1] « A coded concept describing the vision products. (Strength=Example) A coded concept describing the vision products. (Strength=Example) Example Vision Prescription P... Example Vision Prescription P... ?? » ?? » The eye for which the lens applies The eye for which the lens applies eye : : code [0..1] « [0..1] « A coded concept listing the eye codes. (Strength=Required) A coded concept listing the eye codes. (Strength=Required) VisionEyes ! » ! » Lens power measured in diopters (0.25 units) Lens power measured in diopters (0.25 units) sphere : : decimal [0..1] [0..1] Power adjustment for astigmatism measured in diopters (0.25 units) Power adjustment for astigmatism measured in diopters (0.25 units) cylinder : : decimal [0..1] [0..1] Adjustment for astigmatism measured in integer degrees Adjustment for astigmatism measured in integer degrees axis : : integer [0..1] [0..1] Amount of prism to compensate for eye alignment in fractional units Amount of prism to compensate for eye alignment in fractional units prism : : decimal [0..1] [0..1] The relative base, or reference lens edge, for the prism The relative base, or reference lens edge, for the prism base : : code [0..1] « [0..1] « A coded concept listing the base codes. (Strength=Required) A coded concept listing the base codes. (Strength=Required) VisionBase ! » ! » Power adjustment for multifocal lenses measured in diopters (0.25 units) Power adjustment for multifocal lenses measured in diopters (0.25 units) add : : decimal [0..1] [0..1] Contact lens power measured in diopters (0.25 units) Contact lens power measured in diopters (0.25 units) power : : decimal [0..1] [0..1] Back curvature measured in millimeters Back curvature measured in millimeters backCurve : : decimal [0..1] [0..1] Contact lens diameter measured in millimeters Contact lens diameter measured in millimeters diameter : : decimal [0..1] [0..1] The recommended maximum wear period for the lens The recommended maximum wear period for the lens duration : : Quantity ( SimpleQuantity ) [0..1] ) [0..1] Special color or pattern Special color or pattern color : : string [0..1] [0..1] Brand recommendations or restrictions Brand recommendations or restrictions brand : : string [0..1] [0..1] Notes for special requirements such as coatings and lens materials Notes for special requirements such as coatings and lens materials notes : : string [0..1] [0..1] Deals with details of the dispense part of the supply specification Deals with details of the dispense part of the supply specification dispense [0..*]

XML Template XML Template < 

<VisionPrescription xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <
 <</patient>
 <</prescriber>
 <</encounter>
 <</reason[x]>
 <
  <</product>
  <
  <
  <
  <
  <
  <
  <
  <
  <
  <
  <</duration>
  <
  <
  <

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

Turtle Template 


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


[ 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 Description & Constraints doco
. . VisionPrescription Σ DomainResource Prescription for vision correction products for a patient Prescription for vision correction products for a patient
. . . identifier Σ 0..* Identifier Business identifier Business identifier
. . . dateWritten Σ 0..1 dateTime When prescription was authorized When prescription was authorized
. . . patient Σ 0..1 Reference ( Patient ) Who prescription is for Who prescription is for
. . . prescriber Σ 0..1 Reference ( Practitioner ) Who authorizes the vision product Who authorizes the vision product
. . . encounter Σ 0..1 Reference ( Encounter ) Created during encounter / admission / stay Created during encounter / admission / stay
. . . reason[x] Σ 0..1 Reason or indication for writing the prescription Reason or indication for writing the prescription
. . . . reasonCodeableConcept CodeableConcept
. . . reasonReference . reasonReference Reference ( Condition )
. . . dispense Σ 0..* BackboneElement Vision supply authorization Vision supply authorization
. . . . product Σ 1..1 Coding Product to be supplied Product to be supplied
Example Vision Prescription Product Codes ( Example Vision Prescription Product Codes ( Example )
. . . . eye Σ 0..1 code right | left right | left
VisionEyes ( ( Required )
. . . . sphere Σ 0..1 decimal Lens sphere Lens sphere
. . . . cylinder Σ 0..1 decimal Lens cylinder Lens cylinder
. . . . axis Σ 0..1 integer Lens axis Lens axis
. . . . prism Σ 0..1 decimal Lens prism Lens prism
. . . . base Σ 0..1 code up | down | in | out up | down | in | out
VisionBase ( ( Required )
. . . . add Σ 0..1 decimal Lens add Lens add
. . . . power Σ 0..1 decimal Contact lens power Contact lens power
. . . . backCurve Σ 0..1 decimal Contact lens back curvature Contact lens back curvature
. . . . diameter Σ 0..1 decimal Contact lens diameter Contact lens diameter
. . . . duration Σ 0..1 SimpleQuantity Lens wear duration Lens wear duration
. . . . color Σ 0..1 string Lens add Color required
. . . . brand Σ 0..1 string Lens add Brand required
. . . . notes Σ 0..1 string Notes for coatings Notes for coatings

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

VisionPrescription ( ( DomainResource ) Business identifier which may be used by other parties to reference or identify the prescription Business identifier which may be used by other parties to reference or identify the prescription identifier : : Identifier [0..*] [0..*] The date (and perhaps time) when the prescription was written The date (and perhaps time) when the prescription was written dateWritten : : dateTime [0..1] [0..1] A link to a resource representing the person to whom the vision products will be supplied A link to a resource representing the person to whom the vision products will be supplied patient : : Reference [0..1] « [0..1] « Patient » » The healthcare professional responsible for authorizing the prescription The healthcare professional responsible for authorizing the prescription prescriber : : Reference [0..1] « [0..1] « Practitioner » » A link to a resource that identifies the particular occurrence of contact between patient and health care provider A link to a resource that identifies the particular occurrence of contact between patient and health care provider encounter : : Reference [0..1] « [0..1] « Encounter » » Can be the reason or the indication for writing the prescription Can be the reason or the indication for writing the prescription reason[x] : : Type [0..1] « [0..1] « CodeableConcept | Reference ( Condition ) » ) » Dispense Identifies the type of vision correction product which is required for the patient Identifies the type of vision correction product which is required for the patient product : : Coding [1..1] « [1..1] « A coded concept describing the vision products. (Strength=Example) A coded concept describing the vision products. (Strength=Example) Example Vision Prescription P... Example Vision Prescription P... ?? » ?? » The eye for which the lens applies The eye for which the lens applies eye : : code [0..1] « [0..1] « A coded concept listing the eye codes. (Strength=Required) A coded concept listing the eye codes. (Strength=Required) VisionEyes ! » ! » Lens power measured in diopters (0.25 units) Lens power measured in diopters (0.25 units) sphere : : decimal [0..1] [0..1] Power adjustment for astigmatism measured in diopters (0.25 units) Power adjustment for astigmatism measured in diopters (0.25 units) cylinder : : decimal [0..1] [0..1] Adjustment for astigmatism measured in integer degrees Adjustment for astigmatism measured in integer degrees axis : : integer [0..1] [0..1] Amount of prism to compensate for eye alignment in fractional units Amount of prism to compensate for eye alignment in fractional units prism : : decimal [0..1] [0..1] The relative base, or reference lens edge, for the prism The relative base, or reference lens edge, for the prism base : : code [0..1] « [0..1] « A coded concept listing the base codes. (Strength=Required) A coded concept listing the base codes. (Strength=Required) VisionBase ! » ! » Power adjustment for multifocal lenses measured in diopters (0.25 units) Power adjustment for multifocal lenses measured in diopters (0.25 units) add : : decimal [0..1] [0..1] Contact lens power measured in diopters (0.25 units) Contact lens power measured in diopters (0.25 units) power : : decimal [0..1] [0..1] Back curvature measured in millimeters Back curvature measured in millimeters backCurve : : decimal [0..1] [0..1] Contact lens diameter measured in millimeters Contact lens diameter measured in millimeters diameter : : decimal [0..1] [0..1] The recommended maximum wear period for the lens The recommended maximum wear period for the lens duration : : Quantity ( SimpleQuantity ) [0..1] ) [0..1] Special color or pattern Special color or pattern color : : string [0..1] [0..1] Brand recommendations or restrictions Brand recommendations or restrictions brand : : string [0..1] [0..1] Notes for special requirements such as coatings and lens materials Notes for special requirements such as coatings and lens materials notes : : string [0..1] [0..1] Deals with details of the dispense part of the supply specification Deals with details of the dispense part of the supply specification dispense [0..*]

XML Template XML Template < 

<VisionPrescription xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <
 <</patient>
 <</prescriber>
 <</encounter>
 <</reason[x]>
 <
  <</product>
  <
  <
  <
  <
  <
  <
  <
  <
  <
  <
  <</duration>
  <
  <
  <

 <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 JSON Template { "resourceType" : "",

Turtle Template 


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


[ 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 , Resource Profile ( XML , (for ) + JSON Schema , ShEx (for Turtle ), Questionnaire )

4.29.3.1 Terminology Bindings 12.5.3.1 Terminology Bindings

VisionPrescription.dispense.product VisionPrescription.dispense.eye VisionPrescription.dispense.base
Path Definition Type Reference
VisionPrescription.dispense.product A coded concept describing the vision products. A coded concept describing the vision products. Example Example Vision Prescription Product Codes Example Vision Prescription Product Codes
VisionPrescription.dispense.eye A coded concept listing the eye codes. A coded concept listing the eye codes. Required VisionEyes
VisionPrescription.dispense.base A coded concept listing the base codes. A coded concept listing the base codes. Required VisionBase

4.29.4 Search Parameters 12.5.4 Search Parameters Search parameters for this resource. The common parameters also apply. See

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. for more information about searching in REST, messaging, and services.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1
Name Type Description Paths
datewritten date Return prescriptions written on this date Return prescriptions written on this date VisionPrescription.dateWritten
encounter reference Return prescriptions with this encounter identifier Return prescriptions with this encounter identifier VisionPrescription.encounter
( Encounter )
identifier token Return prescriptions with this external identifier Return prescriptions with this external identifier VisionPrescription.identifier
patient reference The identity of a patient to list dispenses for The identity of a patient to list dispenses for VisionPrescription.patient
( Patient )
prescriber reference Who authorizes the vision product Who authorizes the vision product VisionPrescription.prescriber
( Practitioner )