R4 Ballot #1 (Mixed Normative/Trial use)
WorkflowThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Financial Management Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Encounter, Patient, Practitioner |
StructureDefinition for visionprescription
{
"resourceType": "StructureDefinition",
"id": "VisionPrescription",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"name": "VisionPrescription",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "Health Level Seven International (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "An authorization for the supply of glasses and/or contact lenses to a patient.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "VisionPrescription",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "VisionPrescription",
"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": "*",
"base": {
"path": "VisionPrescription",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "rim",
"map": "CombinedVisionRequest"
}
]
},
{
"id": "VisionPrescription.id",
"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.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "VisionPrescription.meta",
"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 might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "VisionPrescription.implicitRules",
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "VisionPrescription.language",
"path": "VisionPrescription.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "VisionPrescription.text",
"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 can 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.",
"comment": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "VisionPrescription.contained",
"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.",
"comment": "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": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VisionPrescription.extension",
"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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VisionPrescription.modifierExtension",
"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. 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.",
"comment": "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": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VisionPrescription.identifier",
"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": "*",
"base": {
"path": "VisionPrescription.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"id": "VisionPrescription.status",
"path": "VisionPrescription.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionStatus"
}
],
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/fm-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": "Act.status"
}
]
},
{
"id": "VisionPrescription.patient",
"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",
"base": {
"path": "VisionPrescription.patient",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject.role"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "VisionPrescription.encounter",
"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",
"base": {
"path": "VisionPrescription.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "componentOf.patientEncounter"
}
]
},
{
"id": "VisionPrescription.dateWritten",
"path": "VisionPrescription.dateWritten",
"short": "When prescription was authorized",
"definition": "The date (and perhaps time) when the prescription was written.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dateWritten",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"id": "VisionPrescription.prescriber",
"path": "VisionPrescription.prescriber",
"short": "Who authorizes the vision product",
"definition": "The healthcare professional responsible for authorizing the prescription.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.prescriber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.requester"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"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"
}
]
},
{
"id": "VisionPrescription.reason[x]",
"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",
"base": {
"path": "VisionPrescription.reason[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Condition"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
},
{
"identity": "rim",
"map": "reason.observation or reason.observation[code=ASSERTION].value"
}
]
},
{
"id": "VisionPrescription.dispense",
"path": "VisionPrescription.dispense",
"short": "Vision supply authorization",
"definition": "Deals with details of the dispense part of the supply specification.",
"min": 0,
"max": "*",
"base": {
"path": "VisionPrescription.dispense",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
},
{
"id": "VisionPrescription.dispense.id",
"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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.extension",
"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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.modifierExtension",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"comment": "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": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VisionPrescription.dispense.product",
"path": "VisionPrescription.dispense.product",
"short": "Product to be supplied",
"definition": "Identifies the type of vision correction product which is required for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.product",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionProduct"
}
],
"strength": "example",
"description": "A coded concept describing the vision products.",
"valueSetCanonical": "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"
}
]
},
{
"id": "VisionPrescription.dispense.eye",
"path": "VisionPrescription.dispense.eye",
"short": "right | left",
"definition": "The eye for which the lens applies.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.eye",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionEyes"
}
],
"strength": "required",
"description": "A coded concept listing the eye codes.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/vision-eye-codes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.sphere",
"path": "VisionPrescription.dispense.sphere",
"short": "Lens sphere",
"definition": "Lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.sphere",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.cylinder",
"path": "VisionPrescription.dispense.cylinder",
"short": "Lens cylinder",
"definition": "Power adjustment for astigmatism measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.cylinder",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.axis",
"path": "VisionPrescription.dispense.axis",
"short": "Lens axis",
"definition": "Adjustment for astigmatism measured in integer degrees.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.axis",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.prism",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Prism"
}
],
"path": "VisionPrescription.dispense.prism",
"short": "Lens prism",
"definition": "Allows for adjustment on two axis.",
"min": 0,
"max": "*",
"base": {
"path": "VisionPrescription.dispense.prism",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "VisionPrescription.dispense.prism.id",
"path": "VisionPrescription.dispense.prism.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.prism.extension",
"path": "VisionPrescription.dispense.prism.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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.prism.modifierExtension",
"path": "VisionPrescription.dispense.prism.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"comment": "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": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "VisionPrescription.dispense.prism.amount",
"path": "VisionPrescription.dispense.prism.amount",
"short": "Amount of adjustment",
"definition": "Amount of prism to compensate for eye alignment in fractional units.",
"min": 1,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.prism.amount",
"min": 1,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.prism.base",
"path": "VisionPrescription.dispense.prism.base",
"short": "up | down | in | out",
"definition": "The relative base, or reference lens edge, for the prism.",
"min": 1,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.prism.base",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionBase"
}
],
"strength": "required",
"description": "A coded concept listing the base codes.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/vision-base-codes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.add",
"path": "VisionPrescription.dispense.add",
"short": "Lens add",
"definition": "Power adjustment for multifocal lenses measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.add",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.power",
"path": "VisionPrescription.dispense.power",
"short": "Contact lens power",
"definition": "Contact lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.power",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.backCurve",
"path": "VisionPrescription.dispense.backCurve",
"short": "Contact lens back curvature",
"definition": "Back curvature measured in millimeters.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.backCurve",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.diameter",
"path": "VisionPrescription.dispense.diameter",
"short": "Contact lens diameter",
"definition": "Contact lens diameter measured in millimeters.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.diameter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.duration",
"path": "VisionPrescription.dispense.duration",
"short": "Lens wear duration",
"definition": "The recommended maximum wear period for the lens.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.duration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.color",
"path": "VisionPrescription.dispense.color",
"short": "Color required",
"definition": "Special color or pattern.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.color",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.brand",
"path": "VisionPrescription.dispense.brand",
"short": "Brand required",
"definition": "Brand recommendations or restrictions.",
"min": 0,
"max": "1",
"base": {
"path": "VisionPrescription.dispense.brand",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.note",
"path": "VisionPrescription.dispense.note",
"short": "Notes for coatings",
"definition": "Notes for special requirements such as coatings and lens materials.",
"min": 0,
"max": "*",
"base": {
"path": "VisionPrescription.dispense.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
]
},
"differential": {
"element": [
{
"id": "VisionPrescription",
"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": "*",
"mapping": [
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "rim",
"map": "CombinedVisionRequest"
}
]
},
{
"id": "VisionPrescription.identifier",
"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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"id": "VisionPrescription.status",
"path": "VisionPrescription.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionStatus"
}
],
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/fm-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": "Act.status"
}
]
},
{
"id": "VisionPrescription.patient",
"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",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject.role"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "VisionPrescription.encounter",
"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",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter"
]
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "componentOf.patientEncounter"
}
]
},
{
"id": "VisionPrescription.dateWritten",
"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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"id": "VisionPrescription.prescriber",
"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",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"
]
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.requester"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"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"
}
]
},
{
"id": "VisionPrescription.reason[x]",
"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",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Condition"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
},
{
"identity": "rim",
"map": "reason.observation or reason.observation[code=ASSERTION].value"
}
]
},
{
"id": "VisionPrescription.dispense",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
},
{
"id": "VisionPrescription.dispense.product",
"path": "VisionPrescription.dispense.product",
"short": "Product to be supplied",
"definition": "Identifies the type of vision correction product which is required for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionProduct"
}
],
"strength": "example",
"description": "A coded concept describing the vision products.",
"valueSetCanonical": "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"
}
]
},
{
"id": "VisionPrescription.dispense.eye",
"path": "VisionPrescription.dispense.eye",
"short": "right | left",
"definition": "The eye for which the lens applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionEyes"
}
],
"strength": "required",
"description": "A coded concept listing the eye codes.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/vision-eye-codes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.sphere",
"path": "VisionPrescription.dispense.sphere",
"short": "Lens sphere",
"definition": "Lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.cylinder",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.axis",
"path": "VisionPrescription.dispense.axis",
"short": "Lens axis",
"definition": "Adjustment for astigmatism measured in integer degrees.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.prism",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Prism"
}
],
"path": "VisionPrescription.dispense.prism",
"short": "Lens prism",
"definition": "Allows for adjustment on two axis.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "VisionPrescription.dispense.prism.amount",
"path": "VisionPrescription.dispense.prism.amount",
"short": "Amount of adjustment",
"definition": "Amount of prism to compensate for eye alignment in fractional units.",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.prism.base",
"path": "VisionPrescription.dispense.prism.base",
"short": "up | down | in | out",
"definition": "The relative base, or reference lens edge, for the prism.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VisionBase"
}
],
"strength": "required",
"description": "A coded concept listing the base codes.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/vision-base-codes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.add",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.power",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.backCurve",
"path": "VisionPrescription.dispense.backCurve",
"short": "Contact lens back curvature",
"definition": "Back curvature measured in millimeters.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.diameter",
"path": "VisionPrescription.dispense.diameter",
"short": "Contact lens diameter",
"definition": "Contact lens diameter measured in millimeters.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.duration",
"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"
]
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.color",
"path": "VisionPrescription.dispense.color",
"short": "Color required",
"definition": "Special color or pattern.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.brand",
"path": "VisionPrescription.dispense.brand",
"short": "Brand required",
"definition": "Brand recommendations or restrictions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VisionPrescription.dispense.note",
"path": "VisionPrescription.dispense.note",
"short": "Notes for coatings",
"definition": "Notes for special requirements such as coatings and lens materials.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
]
}
}
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.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:18+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change