Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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

Content Examples Detailed Descriptions Mappings Profiles & Extensions R3 Conversions 12.16 Resource VisionPrescription - Content

Example ValueSet/process-priority (XML)

An authorization for the provision of glasses and/or contact lenses to a patient. 12.16.1 Scope and Usage The VisionPrescription resource is intended to support the information requirements for a prescription for glasses and contact lenses for a patient. Corrective optical lenses are considered a controlled substance and therefore a prescription is typically required for the provision of patient-specific lenses. 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. 12.16.1.1 Additional Information Additional information regarding resources conveying electronic claims content and usage may be found at: DeviceRequest 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. This resource is referenced by CarePlan , Claim and ExplanationOfBenefit 12.16.3 Resource Content
Financial Management Terminology Infrastructure Work Group Maturity Level : 2   Trial Use Security Category : Patient Compartments : Encounter , Patient , Practitioner N/A Financial Resource Standards Status Lifecycle : how .status is used in the financial resources. 12.16.2 Boundaries and Relationships 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 The VisionPrescription resource is used to provide the authorized specification of lenses for glasses and contacts. Informative 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
Structure Name Flags Card. Type Description & Constraints 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 status ?! Σ 1..1 code active | cancelled | draft | entered-in-error Financial Resource Status Codes ( 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 Example Vision Prescription Product Codes ( Example ) eye Σ 1..1 code right | left VisionEyes ( 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 ( 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 Documentation for this format UML Diagram ( Legend ) VisionPrescription ( DomainResource ) A unique identifier assigned to this vision prescription identifier : Identifier [0..*] 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. (Strength=Required) FinancialResourceStatusCodes ! » 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. (Strength=Example) ExampleVisionPrescriptionProd... ?? » The eye for which the lens specification applies eye : code [1..1] « A coded concept listing the eye codes. (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. (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..*]

Raw XML Template < <!-- from --> <!-- from --> <</identifier> < < <</patient> <</encounter> < <</prescriber> < <</product> < < < < < < < </prism> < < < < <</duration> < < <</note> </lensSpecification> </VisionPrescription> JSON Template { "resourceType" : "", // from // from " " " " " " " " " " " " " " " " }], " " " " " " " " }] } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; 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: ], ...; ] Changes since R3 VisionPrescription 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 Added Element VisionPrescription.lensSpecification.color Added Element VisionPrescription.lensSpecification.brand Added Element VisionPrescription.lensSpecification.note Added Element VisionPrescription.reason[x] deleted VisionPrescription.dispense deleted See the Full Difference ( canonical form for further information This analysis is available as + also see XML Format Specification 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). )

Structure Name Flags Card. Type Description & Constraints 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 status ?! Σ 1..1 code active | cancelled | draft | entered-in-error Financial Resource Status Codes ( Required ) created Σ 1..1 dateTime Response creation date patient Σ 1..1 Reference ( Patient ) Who prescription is Definition 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 Example Vision Prescription Product Value SetProcess Priority Codes ( Example ) eye Σ 1..1 code right | left VisionEyes ( 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 ( 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 Documentation for this format UML Diagram ( Legend )

VisionPrescription ( DomainResource ) A unique identifier assigned to this vision prescription identifier : Identifier [0..*] 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. (Strength=Required) FinancialResourceStatusCodes ! » 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. (Strength=Example) ExampleVisionPrescriptionProd... ?? » The eye for which the lens specification applies eye : code [1..1] « A coded concept listing the eye codes. (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. (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 
<?xml version="1.0" encoding="UTF-8"?>

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="process-priority"/> 
  <meta> 
    <lastUpdated value="2023-03-01T23:03:57.298+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <ul> 
        <li> Include all codes defined in 
          <a href="http://terminology.hl7.org/4.0.0/CodeSystem-processpriority.html">
            <code> http://terminology.hl7.org/CodeSystem/processpriority</code> 
          </a> 
        </li> 
      </ul> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fm"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="draft"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/process-priority"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.552"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.544"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.2.319"/> 
  </identifier> 
  <version value="5.0.0-draft-final"/> 
  <name value="ProcessPriorityCodes"/> 
  <title value="Process Priority Codes"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <publisher value="Financial Management"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="This value set includes the financial processing priority codes."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <copyright value="This is an example set."/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/processpriority"/> 
    </include> 
  </compose> 

  
<
 <!-- from  -->
 <!-- from  -->
 <</identifier>
 <
 <
 <</patient>
 <</encounter>
 <
 <</prescriber>
 <
  <</product>
  <
  <
  <
  <
  <
   <
   <
  </prism>
  <
  <
  <
  <
  <</duration>
  <
  <
  <</note>
 </lensSpecification>
</VisionPrescription>


</

ValueSet


JSON
Template
  
{
  "resourceType" : "",
  // from 
  // from 
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
    "
    "
    "
      "
      "
    }],
    "
    "
    "
    "
    "
    "
    "
    "
  }]
}

>



Turtle
Template

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


[ a fhir:;
  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:
  ], ...;
]

Changes since Release 3 VisionPrescription 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 Usage note: every effort has been made 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 Added Element VisionPrescription.lensSpecification.color Added Element VisionPrescription.lensSpecification.brand Added Element VisionPrescription.lensSpecification.note Added Element VisionPrescription.reason[x] deleted VisionPrescription.dispense deleted See the Full Difference for further information This analysis is available as XML or JSON . See R3 <--> R4 Conversion Maps (status = 2 tests ensure that all execute ok. 1 fail round-trip testing and 2 r3 resources are invalid (0 errors). )   See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis 12.16.3.1 Terminology Bindings Path Definition Type Reference VisionPrescription.status A code specifying the state of the resource instance. Required FinancialResourceStatusCodes VisionPrescription.lensSpecification.product A coded concept describing the vision products. Example ExampleVisionPrescriptionProductCodes VisionPrescription.lensSpecification.eye A coded concept listing the eye codes. Required VisionEyes VisionPrescription.lensSpecification.prism.base A coded concept listing the base codes. Required VisionBase 12.16.4 Search Parameters Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, examples are correct 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 30 Resources patient reference The identity of useful, but they are not a patient to list dispenses for VisionPrescription.patient ( Patient ) 33 Resources prescriber reference Who authorized the vision prescription VisionPrescription.prescriber ( Practitioner , PractitionerRole ) status token The status normative part of the vision prescription VisionPrescription.status specification.