This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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
StructureDefinition for visionprescription
{ "resourceType": "StructureDefinition", "id": "VisionPrescription", "meta": { "lastUpdated": "2015-09-01T14:38:48.206+10:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 } ], "url": "http://hl7.org/fhir/StructureDefinition/VisionPrescription", "name": "VisionPrescription", "status": "draft", "publisher": "Health Level Seven International (Financial Management)", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "other", "value": "http://www.hl7.org/Special/committees/fm/index.cfm" } ] } ], "date": "2015-09-01T14:38:48+10:00", "description": "Base StructureDefinition for VisionPrescription Resource", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2" } ], "kind": "resource", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/DomainResource", "snapshot": { "element": [ { "path": "VisionPrescription", "short": "Prescription for Vision correction products for a patient", "definition": "An authorization for the supply of glasses and/or contact lenses to a patient.", "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "CombinedVisionRequest" }, { "identity": "w5", "map": "clinical.careprovision" } ] }, { "path": "VisionPrescription.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes.", "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. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true }, { "path": "VisionPrescription.meta", "short": "Metadata about the resource", "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.", "min": 0, "max": "1", "type": [ { "code": "Meta" } ], "isSummary": true }, { "path": "VisionPrescription.implicitRules", "short": "A set of rules under which this content was created", "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.", "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 as much as possible.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "path": "VisionPrescription.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "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).", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "path": "VisionPrescription.text", "short": "Text summary of the resource, for human interpretation", "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.", "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "VisionPrescription.contained", "short": "Contained, inline Resources", "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.", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "VisionPrescription.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "VisionPrescription.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "VisionPrescription.identifier", "short": "Business identifier", "definition": "Business identifier which may be used by other parties to reference or identify the prescription.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number" }, { "identity": "rim", "map": "id" } ] }, { "path": "VisionPrescription.dateWritten", "short": "When prescription was authorized", "definition": "The date (and perhaps time) when the prescription was written.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction" }, { "identity": "rim", "map": "author.time" } ] }, { "path": "VisionPrescription.patient", "short": "Who prescription is for", "definition": "A link to a resource representing the person to whom the Vision products will be supplied.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3-Patient ID List" }, { "identity": "rim", "map": "subject.role" } ] }, { "path": "VisionPrescription.prescriber", "short": "Who authorizes the Vision product", "definition": "The healthcare professional responsible for authorizing the prescription.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)" }, { "identity": "rim", "map": "author.role" } ] }, { "path": "VisionPrescription.encounter", "short": "Created during encounter / admission / stay", "definition": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PV1-19-Visit Number" }, { "identity": "rim", "map": "componentOf.patientEncounter" } ] }, { "path": "VisionPrescription.reason[x]", "short": "Reason or indication for writing the prescription", "definition": "Can be the reason or the indication for writing the prescription.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Condition" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-16-Order Control Code Reason" }, { "identity": "rim", "map": "reason.observation or reason.observation[code=ASSERTION].value" } ] }, { "path": "VisionPrescription.dispense", "short": "Vision supply authorization", "definition": "Deals with details of the dispense part of the supply specification.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "component.supplyEvent" } ] }, { "path": "VisionPrescription.dispense.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "VisionPrescription.dispense.extension", "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "VisionPrescription.dispense.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "VisionPrescription.dispense.product", "short": "Product to be supplied", "definition": "Identifies the type of Vision correction product which is required for the patient.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "strength": "example", "description": "A coded concept describing the Vision products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vision-product" } }, "mapping": [ { "identity": "v2", "map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code" }, { "identity": "rim", "map": "consumable.role" } ] }, { "path": "VisionPrescription.dispense.eye", "short": "right | left", "definition": "The eye for which the lens applies.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "A coded concept listing the eye codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vision-eye-codes" } } }, { "path": "VisionPrescription.dispense.sphere", "short": "Lens sphere", "definition": "Lens power measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.cylinder", "short": "Lens cylinder", "definition": "Power adjustment for astigmatism measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.axis", "short": "Lens axis", "definition": "Adjustment for astigmatism measured in integer degrees.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.prism", "short": "Lens prism", "definition": "Amount of prism to compensate for eye alignment in fractional units.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.base", "short": "up | down | in | out", "definition": "The relative base, or reference lens edge, for the prism.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "A coded concept listing the base codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vision-base-codes" } } }, { "path": "VisionPrescription.dispense.add", "short": "Lens add", "definition": "Power adjustment for multifocal lenses measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.power", "short": "Contact Lens power", "definition": "Contact lens power measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.backCurve", "short": "Contact lens back curvature", "definition": "Back Curvature measured in millimeters.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.diameter", "short": "Contact Lens diameter", "definition": "Contact lens diameter measured in millimeters.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.duration", "short": "Lens wear duration", "definition": "The recommended maximum wear period for the lens.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "isSummary": true }, { "path": "VisionPrescription.dispense.color", "short": "Lens add", "definition": "Special color or pattern.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.brand", "short": "Lens add", "definition": "Brand recommendations or restrictions.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.notes", "short": "Notes for coatings", "definition": "Notes for special requirements such as coatings and lens materials.", "alias": [ "0..1" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] }, "differential": { "element": [ { "path": "VisionPrescription", "short": "Prescription for Vision correction products for a patient", "definition": "An authorization for the supply of glasses and/or contact lenses to a patient.", "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "CombinedVisionRequest" }, { "identity": "w5", "map": "clinical.careprovision" } ] }, { "path": "VisionPrescription.identifier", "short": "Business identifier", "definition": "Business identifier which may be used by other parties to reference or identify the prescription.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number" }, { "identity": "rim", "map": "id" } ] }, { "path": "VisionPrescription.dateWritten", "short": "When prescription was authorized", "definition": "The date (and perhaps time) when the prescription was written.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction" }, { "identity": "rim", "map": "author.time" } ] }, { "path": "VisionPrescription.patient", "short": "Who prescription is for", "definition": "A link to a resource representing the person to whom the Vision products will be supplied.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3-Patient ID List" }, { "identity": "rim", "map": "subject.role" } ] }, { "path": "VisionPrescription.prescriber", "short": "Who authorizes the Vision product", "definition": "The healthcare professional responsible for authorizing the prescription.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)" }, { "identity": "rim", "map": "author.role" } ] }, { "path": "VisionPrescription.encounter", "short": "Created during encounter / admission / stay", "definition": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PV1-19-Visit Number" }, { "identity": "rim", "map": "componentOf.patientEncounter" } ] }, { "path": "VisionPrescription.reason[x]", "short": "Reason or indication for writing the prescription", "definition": "Can be the reason or the indication for writing the prescription.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Condition" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-16-Order Control Code Reason" }, { "identity": "rim", "map": "reason.observation or reason.observation[code=ASSERTION].value" } ] }, { "path": "VisionPrescription.dispense", "short": "Vision supply authorization", "definition": "Deals with details of the dispense part of the supply specification.", "min": 0, "max": "*", "isSummary": true, "mapping": [ { "identity": "rim", "map": "component.supplyEvent" } ] }, { "path": "VisionPrescription.dispense.product", "short": "Product to be supplied", "definition": "Identifies the type of Vision correction product which is required for the patient.", "min": 1, "max": "1", "type": [ { "code": "Coding" } ], "isSummary": true, "binding": { "strength": "example", "description": "A coded concept describing the Vision products.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vision-product" } }, "mapping": [ { "identity": "v2", "map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code" }, { "identity": "rim", "map": "consumable.role" } ] }, { "path": "VisionPrescription.dispense.eye", "short": "right | left", "definition": "The eye for which the lens applies.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "A coded concept listing the eye codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vision-eye-codes" } } }, { "path": "VisionPrescription.dispense.sphere", "short": "Lens sphere", "definition": "Lens power measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.cylinder", "short": "Lens cylinder", "definition": "Power adjustment for astigmatism measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.axis", "short": "Lens axis", "definition": "Adjustment for astigmatism measured in integer degrees.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.prism", "short": "Lens prism", "definition": "Amount of prism to compensate for eye alignment in fractional units.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.base", "short": "up | down | in | out", "definition": "The relative base, or reference lens edge, for the prism.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "A coded concept listing the base codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/vision-base-codes" } } }, { "path": "VisionPrescription.dispense.add", "short": "Lens add", "definition": "Power adjustment for multifocal lenses measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.power", "short": "Contact Lens power", "definition": "Contact lens power measured in diopters (0.25 units).", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.backCurve", "short": "Contact lens back curvature", "definition": "Back Curvature measured in millimeters.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.diameter", "short": "Contact Lens diameter", "definition": "Contact lens diameter measured in millimeters.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.duration", "short": "Lens wear duration", "definition": "The recommended maximum wear period for the lens.", "min": 0, "max": "1", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "isSummary": true }, { "path": "VisionPrescription.dispense.color", "short": "Lens add", "definition": "Special color or pattern.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.brand", "short": "Lens add", "definition": "Brand recommendations or restrictions.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "path": "VisionPrescription.dispense.notes", "short": "Notes for coatings", "definition": "Notes for special requirements such as coatings and lens materials.", "alias": [ "0..1" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.