Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

12.16 12.20 Resource VisionPrescription - Content

Financial Management Responsible Owner: Orders and Observations icon Work Group Maturity Level : 2   Trial Use Security Category : Patient Compartments : Encounter , Patient , Practitioner

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

The VisionPrescription resource is intended to support the information requirements represents an authorization for corrective optical lenses to be provided to a prescription for patient. Eye glasses and contact lenses for a patient. Corrective optical lenses are considered a controlled substance and therefore usually require a prescription is typically required for the provision of patient-specific lenses. Details about the fulfillment of the authorization are handled by the Task resource. For further information about this separation of responsibilities, refer to the link Fulfillment/Execution section of the Request pattern.

Vision prescriptions may only be issued by providers who have optical diagnosis within their scope of practice, typically ophthalmologists and optometrists. The prescription is a time-limited, typically two years, authorization for the provision of an unlimited number of lenses, glasses or contacts, which conform to the authorized specification by providers which have lens provision within their scope of practice, typically ophthalmologists , optometrists and opticians.

Health insurers typically require a copy of the prescription to ensure that a vision professional has examined the patient and that the power of the lenses exceeds some minimum, such as +- 0.75 diopters, to qualify for reimbursement under the insurance coverage.

The VisionPrescription resource is an "request" resource from a FHIR workflow perspective - see Workflow Request.

Additional information regarding resources conveying electronic claims content and usage may be found at:

The VisionPrescription resource is used to provide the authorized specification of lenses for glasses and contacts which have well known and internationally consistent requirements, which is distinct from other types of health care authorizations detailed below.

The health care domain includes a number of related resources
VisionPrescription (this resource) The VisionPrescription This resource is used to provide the authorized specification prescribe, authorize, and request provision of lenses for glasses and or contacts.
DeviceRequest This resource is used to prescribe, authorize, and request provision of a health care device such as a halter monitor or a wheelchair services.
MedicationRequest This resource is used to prescribe, authorize, and request provision of medications such a pharmaceuticals and vaccines.
ServiceRequest This resource is used to prescribe, authorize, and request provision of health care services such as consultative or rehabilitative services.
SupplyRequest icon This resource is referenced by used for inventory management of a supply item (which may include a medication, substance or device).

Structure

Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . VisionPrescription TU DomainResource Prescription for vision correction products for a patient

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier 0..* Identifier Business Identifier for vision prescription

. . . basedOn Σ 0..* Reference ( CarePlan | RequestOrchestration | NutritionOrder | ServiceRequest ) What prescription fulfills

... groupIdentifier Σ 0..1 Identifier Composite request identifier
. . . created priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority ( Required )
1..1
. . . created Σ 1..1 dateTime Response creation date
. . . patient Σ 1..1 Reference ( Patient ) Who prescription is for
. . . encounter 0..1 Reference ( Encounter ) Created during encounter / admission / stay
. . . dateWritten Σ 1..1 dateTime When prescription was authorized
. . . prescriber Σ 1..1 Reference ( Practitioner | PractitionerRole ) Who authorized the vision prescription
. . . lensSpecification Σ 1..* BackboneElement Vision lens authorization

. . . . product Σ 1..1 CodeableConcept Product to be supplied
Binding: Example Vision Prescription Product Codes ( Example )
. . . . eye Σ 1..1 code right | left
VisionEyes Binding: Vision Eyes ( Required )
. . . . sphere 0..1 decimal Power of the lens
. . . . cylinder 0..1 decimal Lens power for astigmatism
. . . . axis 0..1 integer Lens meridian which contain no power for astigmatism
. . . . prism 0..* BackboneElement Eye alignment compensation

. . . . . amount 1..1 decimal Amount of adjustment
. . . . . base 1..1 code up | down | in | out
VisionBase Binding: Vision Base ( Required )
. . . . add 0..1 decimal Added power for multifocal levels
. . . . 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..* Annotation Notes for coatings


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

VisionPrescription ( DomainResource ) A unique identifier assigned to this vision prescription identifier : Identifier [0..*] Plan/proposal/order/request fulfilled by this prescription basedOn : Reference [0..*] « CarePlan | RequestOrchestration | NutritionOrder | ServiceRequest » A shared identifier common to all Vision Prescriptions that were authorized more or less simultaneously by a single author, representing the composite or group identifier groupIdentifier : Identifier [0..1] The status of the resource instance (this element modifies the meaning of other elements) status : code [1..1] « A code specifying the state of the resource instance. null (Strength=Required) FinancialResourceStatusCodes ! » Indicates how quickly the vision prescription should be addressed with respect to other requests priority : code [0..1] « null (Strength=Required) RequestPriority ! » The date this resource was created created : dateTime [1..1] A resource reference to the person to whom the vision prescription applies patient : Reference [1..1] « Patient » A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued encounter : Reference [0..1] « Encounter » The date (and perhaps time) when the prescription was written dateWritten : dateTime [1..1] The healthcare professional responsible for authorizing the prescription prescriber : Reference [1..1] « Practitioner | PractitionerRole » LensSpecification Identifies the type of vision correction product which is required for the patient product : CodeableConcept [1..1] « A coded concept describing the vision products. null (Strength=Example) ExampleVisionPrescriptionProd... ?? » The eye for which the lens specification applies eye : code [1..1] « A coded concept listing the eye codes. null (Strength=Required) VisionEyes ! » Lens power measured in dioptres (0.25 units) sphere : decimal [0..1] Power adjustment for astigmatism measured in dioptres (0.25 units) cylinder : decimal [0..1] Adjustment for astigmatism measured in integer degrees axis : integer [0..1] Power adjustment for multifocal lenses measured in dioptres (0.25 units) add : decimal [0..1] Contact lens power measured in dioptres (0.25 units) power : decimal [0..1] Back curvature measured in millimetres backCurve : decimal [0..1] Contact lens diameter measured in millimetres diameter : decimal [0..1] The recommended maximum wear period for the lens duration : Quantity ( SimpleQuantity ) [0..1] Special color or pattern color : string [0..1] Brand recommendations or restrictions brand : string [0..1] Notes for special requirements such as coatings and lens materials note : Annotation [0..*] Prism Amount of prism to compensate for eye alignment in fractional units amount : decimal [1..1] The relative base, or reference lens edge, for the prism base : code [1..1] « A coded concept listing the base codes. null (Strength=Required) VisionBase ! » Allows for adjustment on two axis prism [0..*] Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals lensSpecification [1..*]

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 for vision prescription --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan|NutritionOrder|RequestOrchestration|
   ServiceRequest) What prescription fulfills --></basedOn>

 <groupIdentifier><!-- 0..1 Identifier Composite request identifier --></groupIdentifier>

 <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->

 <created value="[dateTime]"/><!-- 1..1 Response creation date -->
 <patient><!-- 1..1 Reference(Patient) Who prescription is for --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Created during encounter / admission / stay --></encounter>
 <dateWritten value="[dateTime]"/><!-- 1..1 When prescription was authorized -->
 <prescriber><!-- 1..1 Reference(Practitioner|PractitionerRole) Who authorized the vision prescription --></prescriber>
 <lensSpecification>  <!-- 1..* Vision lens authorization -->
  <product><!-- 1..1 CodeableConcept Product to be supplied --></product>
  <eye value="[code]"/><!-- 1..1 right | left -->
  <sphere value="[decimal]"/><!-- 0..1 Power of the lens -->
  <cylinder value="[decimal]"/><!-- 0..1 Lens power for astigmatism -->
  <axis value="[integer]"/><!-- 0..1 Lens meridian which contain no power for astigmatism -->
  <prism>  <!-- 0..* Eye alignment compensation -->
   <amount value="[decimal]"/><!-- 1..1 Amount of adjustment -->
   <base value="[code]"/><!-- 1..1 up | down | in | out -->
  </prism>
  <add value="[decimal]"/><!-- 0..1 Added power for multifocal levels -->
  <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>
 </lensSpecification>
</VisionPrescription>

JSON Template

{doco
  "resourceType" : "VisionPrescription",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for vision prescription
  "basedOn" : [{ Reference(CarePlan|NutritionOrder|RequestOrchestration|
   ServiceRequest) }], // What prescription fulfills

  "groupIdentifier" : { Identifier }, // Composite request identifier

  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "priority" : "<code>", // routine | urgent | asap | stat

  "created" : "<dateTime>", // R!  Response creation date
  "patient" : { Reference(Patient) }, // R!  Who prescription is for
  "encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
  "dateWritten" : "<dateTime>", // R!  When prescription was authorized
  "prescriber" : { Reference(Practitioner|PractitionerRole) }, // R!  Who authorized the vision prescription
  "lensSpecification" : [{ // R!  Vision lens authorization
    "product" : { CodeableConcept }, // R!  Product to be supplied
    "eye" : "<code>", // R!  right | left
    "sphere" : <decimal>, // Power of the lens
    "cylinder" : <decimal>, // Lens power for astigmatism
    "axis" : <integer>, // Lens meridian which contain no power for astigmatism
    "prism" : [{ // Eye alignment compensation
      "amount" : <decimal>, // R!  Amount of adjustment
      "base" : "<code>" // R!  up | down | in | out
    }],
    "add" : <decimal>, // Added power for multifocal levels
    "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/> .doco


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

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
    ], ...;
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier for vision prescription
  fhir:basedOn  ( [ Reference(CarePlan|NutritionOrder|RequestOrchestration|ServiceRequest) ] ... ) ; # 0..* What prescription fulfills
  fhir:groupIdentifier [ Identifier ] ; # 0..1 Composite request identifier
  fhir:status [ code ] ; # 1..1 active | cancelled | draft | entered-in-error
  fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat
  fhir:created [ dateTime ] ; # 1..1 Response creation date
  fhir:patient [ Reference(Patient) ] ; # 1..1 Who prescription is for
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Created during encounter / admission / stay
  fhir:dateWritten [ dateTime ] ; # 1..1 When prescription was authorized
  fhir:prescriber [ Reference(Practitioner|PractitionerRole) ] ; # 1..1 Who authorized the vision prescription
  fhir:lensSpecification ( [ # 1..* Vision lens authorization
    fhir:product [ CodeableConcept ] ; # 1..1 Product to be supplied
    fhir:eye [ code ] ; # 1..1 right | left
    fhir:sphere [ decimal ] ; # 0..1 Power of the lens
    fhir:cylinder [ decimal ] ; # 0..1 Lens power for astigmatism
    fhir:axis [ integer ] ; # 0..1 Lens meridian which contain no power for astigmatism
    fhir:prism ( [ # 0..* Eye alignment compensation
      fhir:amount [ decimal ] ; # 1..1 Amount of adjustment
      fhir:base [ code ] ; # 1..1 up | down | in | out
    ] ... ) ;
    fhir:add [ decimal ] ; # 0..1 Added power for multifocal levels
    fhir:power [ decimal ] ; # 0..1 Contact lens power
    fhir:backCurve [ decimal ] ; # 0..1 Contact lens back curvature
    fhir:diameter [ decimal ] ; # 0..1 Contact lens diameter
    fhir:duration [ Quantity(SimpleQuantity) ] ; # 0..1 Lens wear duration
    fhir:color [ string ] ; # 0..1 Color required
    fhir:brand [ string ] ; # 0..1 Brand required
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Notes for coatings
  ] ... ) ;

]

Changes since R3 from both R4 and R4B

VisionPrescription.status Min Cardinality changed from 0 to 1 Change value set from http://hl7.org/fhir/ValueSet/fm-status to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 VisionPrescription.created Added Mandatory Element VisionPrescription.patient Min Cardinality changed from 0 to 1 VisionPrescription.dateWritten Min Cardinality changed from 0 to 1 VisionPrescription.prescriber Min Cardinality changed from 0 to 1 Type Reference: Added Target Type PractitionerRole VisionPrescription.lensSpecification Added Mandatory Element VisionPrescription.lensSpecification.product Added Mandatory Element VisionPrescription.lensSpecification.eye Added Mandatory Element VisionPrescription.lensSpecification.sphere Added Element VisionPrescription.lensSpecification.cylinder Added Element VisionPrescription.lensSpecification.axis Added Element VisionPrescription.lensSpecification.prism Added Element VisionPrescription.lensSpecification.prism.amount Added Mandatory Element VisionPrescription.lensSpecification.prism.base Added Mandatory Element VisionPrescription.lensSpecification.add Added Element VisionPrescription.lensSpecification.power Added Element VisionPrescription.lensSpecification.backCurve Added Element VisionPrescription.lensSpecification.diameter Added Element VisionPrescription.lensSpecification.duration VisionPrescription.reason[x] deleted VisionPrescription.dispense deleted
VisionPrescription Added Element
VisionPrescription.lensSpecification.color VisionPrescription.basedOn
  • Added Element
VisionPrescription.lensSpecification.brand VisionPrescription.groupIdentifier
  • Added Element
VisionPrescription.lensSpecification.note VisionPrescription.priority
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. 1 fail round-trip testing and 2 r3 resources are invalid (0 errors). ) for R4B as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . VisionPrescription TU DomainResource Prescription for vision correction products for a patient

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier 0..* Identifier Business Identifier for vision prescription

. . . basedOn Σ 0..* Reference ( CarePlan | RequestOrchestration | NutritionOrder | ServiceRequest ) What prescription fulfills

... groupIdentifier Σ 0..1 Identifier Composite request identifier
. . . created priority Σ 0..1 code 1..1 routine | urgent | asap | stat
Binding: RequestPriority ( Required )
. . . created Σ 1..1 dateTime Response creation date
. . . patient Σ 1..1 Reference ( Patient ) Who prescription is for
. . . encounter 0..1 Reference ( Encounter ) Created during encounter / admission / stay
. . . dateWritten Σ 1..1 dateTime When prescription was authorized
. . . prescriber Σ 1..1 Reference ( Practitioner | PractitionerRole ) Who authorized the vision prescription
. . . lensSpecification Σ 1..* BackboneElement Vision lens authorization

. . . . product Σ 1..1 CodeableConcept Product to be supplied
Binding: Example Vision Prescription Product Codes ( Example )
. . . . eye Σ 1..1 code right | left
VisionEyes Binding: Vision Eyes ( Required )
. . . . sphere 0..1 decimal Power of the lens
. . . . cylinder 0..1 decimal Lens power for astigmatism
. . . . axis 0..1 integer Lens meridian which contain no power for astigmatism
. . . . prism 0..* BackboneElement Eye alignment compensation

. . . . . amount 1..1 decimal Amount of adjustment
. . . . . base 1..1 code up | down | in | out
VisionBase Binding: Vision Base ( Required )
. . . . add 0..1 decimal Added power for multifocal levels
. . . . 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..* Annotation Notes for coatings


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

VisionPrescription ( DomainResource ) A unique identifier assigned to this vision prescription identifier : Identifier [0..*] Plan/proposal/order/request fulfilled by this prescription basedOn : Reference [0..*] « CarePlan | RequestOrchestration | NutritionOrder | ServiceRequest » A shared identifier common to all Vision Prescriptions that were authorized more or less simultaneously by a single author, representing the composite or group identifier groupIdentifier : Identifier [0..1] The status of the resource instance (this element modifies the meaning of other elements) status : code [1..1] « A code specifying the state of the resource instance. null (Strength=Required) FinancialResourceStatusCodes ! » Indicates how quickly the vision prescription should be addressed with respect to other requests priority : code [0..1] « null (Strength=Required) RequestPriority ! » The date this resource was created created : dateTime [1..1] A resource reference to the person to whom the vision prescription applies patient : Reference [1..1] « Patient » A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued encounter : Reference [0..1] « Encounter » The date (and perhaps time) when the prescription was written dateWritten : dateTime [1..1] The healthcare professional responsible for authorizing the prescription prescriber : Reference [1..1] « Practitioner | PractitionerRole » LensSpecification Identifies the type of vision correction product which is required for the patient product : CodeableConcept [1..1] « A coded concept describing the vision products. null (Strength=Example) ExampleVisionPrescriptionProd... ?? » The eye for which the lens specification applies eye : code [1..1] « A coded concept listing the eye codes. null (Strength=Required) VisionEyes ! » Lens power measured in dioptres (0.25 units) sphere : decimal [0..1] Power adjustment for astigmatism measured in dioptres (0.25 units) cylinder : decimal [0..1] Adjustment for astigmatism measured in integer degrees axis : integer [0..1] Power adjustment for multifocal lenses measured in dioptres (0.25 units) add : decimal [0..1] Contact lens power measured in dioptres (0.25 units) power : decimal [0..1] Back curvature measured in millimetres backCurve : decimal [0..1] Contact lens diameter measured in millimetres diameter : decimal [0..1] The recommended maximum wear period for the lens duration : Quantity ( SimpleQuantity ) [0..1] Special color or pattern color : string [0..1] Brand recommendations or restrictions brand : string [0..1] Notes for special requirements such as coatings and lens materials note : Annotation [0..*] Prism Amount of prism to compensate for eye alignment in fractional units amount : decimal [1..1] The relative base, or reference lens edge, for the prism base : code [1..1] « A coded concept listing the base codes. null (Strength=Required) VisionBase ! » Allows for adjustment on two axis prism [0..*] Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals lensSpecification [1..*]

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 for vision prescription --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan|NutritionOrder|RequestOrchestration|
   ServiceRequest) What prescription fulfills --></basedOn>

 <groupIdentifier><!-- 0..1 Identifier Composite request identifier --></groupIdentifier>

 <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->

 <created value="[dateTime]"/><!-- 1..1 Response creation date -->
 <patient><!-- 1..1 Reference(Patient) Who prescription is for --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Created during encounter / admission / stay --></encounter>
 <dateWritten value="[dateTime]"/><!-- 1..1 When prescription was authorized -->
 <prescriber><!-- 1..1 Reference(Practitioner|PractitionerRole) Who authorized the vision prescription --></prescriber>
 <lensSpecification>  <!-- 1..* Vision lens authorization -->
  <product><!-- 1..1 CodeableConcept Product to be supplied --></product>
  <eye value="[code]"/><!-- 1..1 right | left -->
  <sphere value="[decimal]"/><!-- 0..1 Power of the lens -->
  <cylinder value="[decimal]"/><!-- 0..1 Lens power for astigmatism -->
  <axis value="[integer]"/><!-- 0..1 Lens meridian which contain no power for astigmatism -->
  <prism>  <!-- 0..* Eye alignment compensation -->
   <amount value="[decimal]"/><!-- 1..1 Amount of adjustment -->
   <base value="[code]"/><!-- 1..1 up | down | in | out -->
  </prism>
  <add value="[decimal]"/><!-- 0..1 Added power for multifocal levels -->
  <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>
 </lensSpecification>
</VisionPrescription>

JSON Template

{doco
  "resourceType" : "VisionPrescription",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for vision prescription
  "basedOn" : [{ Reference(CarePlan|NutritionOrder|RequestOrchestration|
   ServiceRequest) }], // What prescription fulfills

  "groupIdentifier" : { Identifier }, // Composite request identifier

  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  "priority" : "<code>", // routine | urgent | asap | stat

  "created" : "<dateTime>", // R!  Response creation date
  "patient" : { Reference(Patient) }, // R!  Who prescription is for
  "encounter" : { Reference(Encounter) }, // Created during encounter / admission / stay
  "dateWritten" : "<dateTime>", // R!  When prescription was authorized
  "prescriber" : { Reference(Practitioner|PractitionerRole) }, // R!  Who authorized the vision prescription
  "lensSpecification" : [{ // R!  Vision lens authorization
    "product" : { CodeableConcept }, // R!  Product to be supplied
    "eye" : "<code>", // R!  right | left
    "sphere" : <decimal>, // Power of the lens
    "cylinder" : <decimal>, // Lens power for astigmatism
    "axis" : <integer>, // Lens meridian which contain no power for astigmatism
    "prism" : [{ // Eye alignment compensation
      "amount" : <decimal>, // R!  Amount of adjustment
      "base" : "<code>" // R!  up | down | in | out
    }],
    "add" : <decimal>, // Added power for multifocal levels
    "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/> .doco


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

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
    ], ...;
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifier for vision prescription
  fhir:basedOn  ( [ Reference(CarePlan|NutritionOrder|RequestOrchestration|ServiceRequest) ] ... ) ; # 0..* What prescription fulfills
  fhir:groupIdentifier [ Identifier ] ; # 0..1 Composite request identifier
  fhir:status [ code ] ; # 1..1 active | cancelled | draft | entered-in-error
  fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat
  fhir:created [ dateTime ] ; # 1..1 Response creation date
  fhir:patient [ Reference(Patient) ] ; # 1..1 Who prescription is for
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Created during encounter / admission / stay
  fhir:dateWritten [ dateTime ] ; # 1..1 When prescription was authorized
  fhir:prescriber [ Reference(Practitioner|PractitionerRole) ] ; # 1..1 Who authorized the vision prescription
  fhir:lensSpecification ( [ # 1..* Vision lens authorization
    fhir:product [ CodeableConcept ] ; # 1..1 Product to be supplied
    fhir:eye [ code ] ; # 1..1 right | left
    fhir:sphere [ decimal ] ; # 0..1 Power of the lens
    fhir:cylinder [ decimal ] ; # 0..1 Lens power for astigmatism
    fhir:axis [ integer ] ; # 0..1 Lens meridian which contain no power for astigmatism
    fhir:prism ( [ # 0..* Eye alignment compensation
      fhir:amount [ decimal ] ; # 1..1 Amount of adjustment
      fhir:base [ code ] ; # 1..1 up | down | in | out
    ] ... ) ;
    fhir:add [ decimal ] ; # 0..1 Added power for multifocal levels
    fhir:power [ decimal ] ; # 0..1 Contact lens power
    fhir:backCurve [ decimal ] ; # 0..1 Contact lens back curvature
    fhir:diameter [ decimal ] ; # 0..1 Contact lens diameter
    fhir:duration [ Quantity(SimpleQuantity) ] ; # 0..1 Lens wear duration
    fhir:color [ string ] ; # 0..1 Color required
    fhir:brand [ string ] ; # 0..1 Brand required
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Notes for coatings
  ] ... ) ;

]

Changes since Release 3 from both R4 and R4B

VisionPrescription.status Min Cardinality changed from 0 to 1 Change value set from http://hl7.org/fhir/ValueSet/fm-status to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 VisionPrescription.created Added Mandatory Element VisionPrescription.patient Min Cardinality changed from 0 to 1 VisionPrescription.dateWritten Min Cardinality changed from 0 to 1 VisionPrescription.prescriber Min Cardinality changed from 0 to 1 Type Reference: Added Target Type PractitionerRole VisionPrescription.lensSpecification Added Mandatory Element VisionPrescription.lensSpecification.product Added Mandatory Element VisionPrescription.lensSpecification.eye Added Mandatory Element VisionPrescription.lensSpecification.sphere Added Element VisionPrescription.lensSpecification.cylinder Added Element VisionPrescription.lensSpecification.axis Added Element VisionPrescription.lensSpecification.prism Added Element VisionPrescription.lensSpecification.prism.amount Added Mandatory Element VisionPrescription.lensSpecification.prism.base Added Mandatory Element VisionPrescription.lensSpecification.add Added Element VisionPrescription.lensSpecification.power Added Element VisionPrescription.lensSpecification.backCurve Added Element VisionPrescription.lensSpecification.diameter Added Element VisionPrescription.lensSpecification.duration VisionPrescription.reason[x] deleted VisionPrescription.dispense deleted
VisionPrescription Added Element
VisionPrescription.lensSpecification.color VisionPrescription.basedOn
  • Added Element
VisionPrescription.lensSpecification.brand VisionPrescription.groupIdentifier
  • Added Element
VisionPrescription.lensSpecification.note VisionPrescription.priority
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. 1 fail round-trip testing and 2 r3 resources are invalid (0 errors). ) for R4B as XML or JSON .

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

Path Definition ValueSet Type Reference Documentation
VisionPrescription.status A code specifying the state of the resource instance. FinancialResourceStatusCodes Required

This value set includes Status codes.

VisionPrescription.priority FinancialResourceStatusCodes RequestPriority Required

Identifies the level of importance to be assigned to actioning the request.

VisionPrescription.lensSpecification.product A coded concept describing the vision products. ExampleVisionPrescriptionProductCodes Example ExampleVisionPrescriptionProductCodes

This value set includes a smattering of Prescription Product codes.

VisionPrescription.lensSpecification.eye A coded concept listing the eye codes. VisionEyes Required VisionEyes VisionPrescription.lensSpecification.prism.base

A coded concept listing the base eye codes.

VisionPrescription.lensSpecification.prism.base VisionBase Required VisionBase

A coded concept listing the base codes.

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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 27 Resources
identifier token Return prescriptions with this external identifier VisionPrescription.identifier 30 59 Resources
patient reference The identity of a patient to list dispenses for VisionPrescription.patient
( Patient )
33 61 Resources
prescriber reference Who authorized the vision prescription VisionPrescription.prescriber
( Practitioner , PractitionerRole )
product token The type of product being prescribed VisionPrescription.lensSpecification.product
status token The status of the vision prescription VisionPrescription.status