0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: VisionPrescriptionSTU3 - Detailed Descriptions

Definitions for the profile-visionprescription-stu3 Profile.

1. VisionPrescription
Definition | An authorization for the supply of glasses and/or contact lenses to a patient.
Control | 0..*
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
2. VisionPrescription.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. VisionPrescription.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
4. VisionPrescription.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
5. VisionPrescription.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable Max Binding: All Languages
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
6. VisionPrescription.text
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
7. VisionPrescription.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
8. VisionPrescription.extension
Definition | An Extension
Control | 0..*
Type | Extension
9. VisionPrescription.extension:VisionPrescription-insurance
Definition | Indicates coverage relevant to the request.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(insurance) (Extension Type: Reference(CoverageSTU3))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. VisionPrescription.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
11. VisionPrescription.identifier
Definition | Business identifier which may be used by other parties to reference or identify the prescription.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
12. VisionPrescription.status
Definition | The status of the resource instance.
Control | 1..1
Binding | A code specifying the state of the resource instance. The codes SHALL be taken from Financial Resource Status Codes
Type | code
Is Modifier | true
Must Support | true
Fixed Value | draft
13. VisionPrescription.patient
Definition | A link to a resource representing the person to whom the vision products will be supplied.
Control | 1..1
Type | Reference(PatientSTU3)
Must Support | true
14. VisionPrescription.encounter
Definition | A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
Control | 0..1
Type | Reference(EncounterSTU3)
Comments | potentially relevant for CRD in some situations.
15. VisionPrescription.dateWritten
Definition | The date (and perhaps time) when the prescription was written.
Control | 1..1
Type | dateTime
Must Support | true
16. VisionPrescription.prescriber
Definition | The healthcare professional responsible for authorizing the prescription.
Control | 1..1
Type | Reference(PractitionerSTU3)
Must Support | true
17. VisionPrescription.reason[x]
Definition | Can be the reason or the indication for writing the prescription.
Control | 0..1
Type | Choice of: CodeableConcept, Reference(US Core Condition Profile)
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Comments | potentially relevant for CRD in some situations.
18. VisionPrescription.dispense
Definition | Deals with details of the dispense part of the supply specification.
Control | 0..*
Type | BackboneElement
Must Support | true
Comments | potentially relevant for CRD in some situations.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
19. VisionPrescription.dispense.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
20. VisionPrescription.dispense.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
21. VisionPrescription.dispense.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
22. VisionPrescription.dispense.product
Definition | Identifies the type of vision correction product which is required for the patient.
Control | 0..1
Binding | A coded concept describing the vision products. For example codes, see Example Vision Prescription Product Codes
Type | CodeableConcept
23. VisionPrescription.dispense.eye
Definition | The eye for which the lens applies.
Control | 0..1
Binding | A coded concept listing the eye codes. The codes SHALL be taken from VisionEyes
Type | code
24. VisionPrescription.dispense.sphere
Definition | Lens power measured in diopters (0.25 units).
Control | 0..1
Type | decimal
25. VisionPrescription.dispense.cylinder
Definition | Power adjustment for astigmatism measured in diopters (0.25 units).
Control | 0..1
Type | decimal
26. VisionPrescription.dispense.axis
Definition | Adjustment for astigmatism measured in integer degrees.
Control | 0..1
Type | integer
27. VisionPrescription.dispense.prism
Definition | Amount of prism to compensate for eye alignment in fractional units.
Control | 0..1
Type | decimal
28. VisionPrescription.dispense.base
Definition | The relative base, or reference lens edge, for the prism.
Control | 0..1
Binding | A coded concept listing the base codes. The codes SHALL be taken from VisionBase
Type | code
29. VisionPrescription.dispense.add
Definition | Power adjustment for multifocal lenses measured in diopters (0.25 units).
Control | 0..1
Type | decimal
30. VisionPrescription.dispense.power
Definition | Contact lens power measured in diopters (0.25 units).
Control | 0..1
Type | decimal
31. VisionPrescription.dispense.backCurve
Definition | Back curvature measured in millimeters.
Control | 0..1
Type | decimal
32. VisionPrescription.dispense.diameter
Definition | Contact lens diameter measured in millimeters.
Control | 0..1
Type | decimal
33. VisionPrescription.dispense.duration
Definition | The recommended maximum wear period for the lens.
Control | 0..1
Type | Quantity(SimpleQuantity)
34. VisionPrescription.dispense.color
Definition | Special color or pattern.
Control | 0..1
Type | string
35. VisionPrescription.dispense.brand
Definition | Brand recommendations or restrictions.
Control | 0..1
Type | string
36. VisionPrescription.dispense.note
Definition | Notes for special requirements such as coatings and lens materials.
Control | 0..*
Type | Annotation