This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.3.0:
R4
Ballot
2).
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 | Trial Use | 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
|
|---|---|---|---|---|
|
TU | DomainResource |
Prescription
for
vision
correction
products
for
a
patient
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Business
identifier
|
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Financial Resource Status Codes ( Required ) |
|
0..1 | Reference ( Patient ) | Who prescription is for | |
|
0..1 | Reference ( Encounter ) | Created during encounter / admission / stay | |
|
0..1 | dateTime | When prescription was authorized | |
|
0..1 | Reference ( Practitioner | PractitionerRole ) | Who authorizes the vision product | |
|
0..1 | Reason or indication for writing the prescription | ||
|
CodeableConcept | |||
|
Reference ( Condition ) | |||
|
0..* | BackboneElement |
Vision
supply
authorization
|
|
|
0..1 | CodeableConcept |
Product
to
be
supplied
Example Vision Prescription Product Codes ( Example ) |
|
|
0..1 | code |
right
|
left
VisionEyes ( Required ) |
|
|
0..1 | decimal | Lens sphere | |
|
0..1 | decimal | Lens cylinder | |
|
0..1 | integer | Lens axis | |
|
|
|
Lens
prism
|
|
| 1..1 | decimal | Amount of adjustment | |
![]() ![]() ![]() ![]() |
|
code |
up
|
down
|
in
|
out
VisionBase ( Required ) |
|
|
0..1 | decimal | Lens add | |
|
0..1 | decimal | Contact lens power | |
|
0..1 | decimal | Contact lens back curvature | |
|
0..1 | decimal | Contact lens diameter | |
|
0..1 | SimpleQuantity | Lens wear duration | |
|
0..1 | string | Color required | |
|
0..1 | string | Brand required | |
|
0..* | Annotation |
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>< <</prescriber><dateWritten value="[dateTime]"/><!-- 0..1 When prescription was authorized --> <prescriber><!-- 0..1 Reference(Practitioner|PractitionerRole) 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 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> <!-- 0..* Lens prism --> <amount value="[decimal]"/><!-- 1..1 Amount of adjustment --> <base value="[code]"/><!-- 1..1 up | down | in | out --> </prism> <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><!-- 0..* Annotation Notes for coatings --></note> </dispense> </VisionPrescription>
JSON Template
{
"resourceType" : "",
"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|PractitionerRole) }, // 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" : "<code>", // right | left
"sphere" : <decimal>, // Lens sphere
"cylinder" : <decimal>, // Lens cylinder
"axis" : <integer>, // Lens axis
"prism" : [{ // Lens prism
"amount" : <decimal>, // R! Amount of adjustment
"base" : "<code>" // R! 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" : [{ Annotation }] // 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.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:VisionPrescription.patient [ Reference(Patient) ]; # 0..1 Who prescription is for fhir:VisionPrescription.encounter [ Reference(Encounter) ]; # 0..1 Created during encounter / admission / stay fhir:VisionPrescription.dateWritten [ dateTime ]; # 0..1 When prescription was authorized
fhir:fhir:VisionPrescription.prescriber [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Who authorizes the vision product # 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 [ CodeableConcept ]; # 0..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 axisfhir: fhir:fhir:VisionPrescription.dispense.prism [ # 0..* Lens prism fhir:VisionPrescription.dispense.prism.amount [ decimal ]; # 1..1 Amount of adjustment fhir:VisionPrescription.dispense.prism.base [ code ]; # 1..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.note [ Annotation ], ... ; # 0..* Notes for coatings ], ...; ]
Changes
since
DSTU2
R3
| VisionPrescription | |
|
|
|
|
|
|
| VisionPrescription.dispense.prism |
|
|
|
|
| VisionPrescription.dispense.prism.base |
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 2 fail round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Prescription
for
vision
correction
products
for
a
patient
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Business
identifier
|
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Financial Resource Status Codes ( Required ) |
|
0..1 | Reference ( Patient ) | Who prescription is for | |
|
0..1 | Reference ( Encounter ) | Created during encounter / admission / stay | |
|
0..1 | dateTime | When prescription was authorized | |
|
0..1 | Reference ( Practitioner | PractitionerRole ) | Who authorizes the vision product | |
|
0..1 | Reason or indication for writing the prescription | ||
|
CodeableConcept | |||
|
Reference ( Condition ) | |||
|
0..* | BackboneElement |
Vision
supply
authorization
|
|
|
0..1 | CodeableConcept |
Product
to
be
supplied
Example Vision Prescription Product Codes ( Example ) |
|
|
0..1 | code |
right
|
left
VisionEyes ( Required ) |
|
|
0..1 | decimal | Lens sphere | |
|
0..1 | decimal | Lens cylinder | |
|
0..1 | integer | Lens axis | |
|
|
|
Lens
prism
|
|
| 1..1 | decimal | Amount of adjustment | |
![]() ![]() ![]() ![]() |
|
code |
up
|
down
|
in
|
out
VisionBase ( Required ) |
|
|
0..1 | decimal | Lens add | |
|
0..1 | decimal | Contact lens power | |
|
0..1 | decimal | Contact lens back curvature | |
|
0..1 | decimal | Contact lens diameter | |
|
0..1 | SimpleQuantity | Lens wear duration | |
|
0..1 | string | Color required | |
|
0..1 | string | Brand required | |
|
0..* | Annotation |
Notes
for
coatings
|
|
Documentation
for
this
format
|
||||
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>< <</prescriber><dateWritten value="[dateTime]"/><!-- 0..1 When prescription was authorized --> <prescriber><!-- 0..1 Reference(Practitioner|PractitionerRole) 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 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> <!-- 0..* Lens prism --> <amount value="[decimal]"/><!-- 1..1 Amount of adjustment --> <base value="[code]"/><!-- 1..1 up | down | in | out --> </prism> <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><!-- 0..* Annotation Notes for coatings --></note> </dispense> </VisionPrescription>
JSON Template
{
"resourceType" : "",
"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|PractitionerRole) }, // 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" : "<code>", // right | left
"sphere" : <decimal>, // Lens sphere
"cylinder" : <decimal>, // Lens cylinder
"axis" : <integer>, // Lens axis
"prism" : [{ // Lens prism
"amount" : <decimal>, // R! Amount of adjustment
"base" : "<code>" // R! 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" : [{ Annotation }] // 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.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:VisionPrescription.patient [ Reference(Patient) ]; # 0..1 Who prescription is for fhir:VisionPrescription.encounter [ Reference(Encounter) ]; # 0..1 Created during encounter / admission / stay fhir:VisionPrescription.dateWritten [ dateTime ]; # 0..1 When prescription was authorized
fhir:fhir:VisionPrescription.prescriber [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Who authorizes the vision product # 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 [ CodeableConcept ]; # 0..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 axisfhir: fhir:fhir:VisionPrescription.dispense.prism [ # 0..* Lens prism fhir:VisionPrescription.dispense.prism.amount [ decimal ]; # 1..1 Amount of adjustment fhir:VisionPrescription.dispense.prism.base [ code ]; # 1..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.note [ Annotation ], ... ; # 0..* Notes for coatings ], ...; ]
Changes since DSTU2
| VisionPrescription | |
|
|
|
|
|
|
| VisionPrescription.dispense.prism |
|
|
|
|
| VisionPrescription.dispense.prism.base |
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 2 fail round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4
Alternate
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
| 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 |
|
|
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 | Expression | 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 ) |
|
| prescriber | reference | Who authorizes the vision product |
VisionPrescription.prescriber
( Practitioner , PractitionerRole ) |
|
| status | token | The status of the vision prescription | VisionPrescription.status |