{ "resourceType": "StructureDefinition", "id": "au-medlist", "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" List 0..*ListA list of medications in an Australian healthcare context
\".\"\".\"\".\" extension 0..*ExtensionSlice: Unordered, Open by value:url
\".\"\".\"\".\" author-role 0..1Reference(PractitionerRole)Practitioner role that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-role
\".\"\".\"\".\" author-related-person 0..1Reference(RelatedPerson)Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
\".\"\".\"\".\" entry 0..*BackboneElementMedicine list entry
\".\"\".\"\".\"\".\" extension 0..*ExtensionSlice: Unordered, Open by value:url
\".\"\".\"\".\"\".\" change-description 0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
\".\"\".\"\".\"\".\" flag 0..1CodeableConceptMedicine item change
Binding: Medicine Item Change (preferred)
\".\"\".\"\".\"\".\" item 1..1Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)

\"doco\" Documentation for this format
" }, "url": "http://hl7.org.au/fhir/StructureDefinition/au-medlist", "version": "1.1.1", "name": "AUMedicineList", "title": "AU Medicine List", "status": "draft", "date": "2018-11-30T00:00:00+11:00", "publisher": "Health Level Seven Australia (Medications WG)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org.au/fhir", "use": "work" } ] } ], "description": "This profile defines a list structure including core localisation concepts for use as a medicines list in an Australian context. This profile is intended to offer a common structure and expectations to record, exchange, and fetch a list of medications associated with a patient in an Australian healthcare context.", "fhirVersion": "3.0.2", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" } ], "kind": "resource", "abstract": false, "type": "List", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/List", "derivation": "constraint", "snapshot": { "element": [ { "id": "List", "path": "List", "short": "A list of medications in an Australian healthcare context", "definition": "A set of information summarized from a list of other resources.", "alias": [ "Collection", "WorkingList", "Organizer" ], "min": 0, "max": "*", "base": { "path": "List", "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", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" }, { "key": "lst-2", "severity": "error", "human": "The deleted flag can only be used if the mode of the list is \"changes\"", "expression": "mode = 'changes' or entry.deleted.empty()", "xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:deleted))", "source": "http://hl7.org/fhir/StructureDefinition/List" }, { "key": "lst-1", "severity": "error", "human": "A list can only have an emptyReason if it is empty", "expression": "emptyReason.empty() or entry.empty()", "xpath": "not(exists(f:emptyReason) and exists(f:entry))", "source": "http://hl7.org/fhir/StructureDefinition/List" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ] }, { "id": "List.extension:sourceRelatedPerson", "path": "List.extension", "sliceName": "sourceRelatedPerson", "short": "Related person that defined the list contents (aka Author)", "definition": "The entity (related person) responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.", "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/author-related-person" } ], "condition": [ "ele-1" ], "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" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ] }, { "id": "List.modifierExtension", "path": "List.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.", "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, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "List.identifier", "path": "List.identifier", "short": "Business identifier", "definition": "Identifier for the List assigned for business purposes outside the context of FHIR.", "min": 0, "max": "*", "base": { "path": "List.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "List.status", "path": "List.status", "short": "current | retired | entered-in-error", "definition": "Indicates the current state of this list.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "base": { "path": "List.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListStatus" } ], "strength": "required", "description": "The current state of the list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-status" } }, "mapping": [ { "identity": "rim", "map": ".status[current=active;retired=obsolete;entered-in-error=nullified]" }, { "identity": "w5", "map": "status" } ] }, { "id": "List.mode", "path": "List.mode", "short": "working | snapshot | changes", "definition": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "comment": "This element is labeled as a modifier because a change list must not be mis-understood as a complete list.", "requirements": "Lists are used in various ways, and it must be known in what way it is safe to use them.", "min": 1, "max": "1", "base": { "path": "List.mode", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListMode" } ], "strength": "required", "description": "The processing mode that applies to this list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-mode" } }, "mapping": [ { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "w5", "map": "class" } ] }, { "id": "List.title", "path": "List.title", "short": "Descriptive name for the list", "definition": "A label for the list assigned by the author.", "requirements": "Allows customization beyond just the code identifying the kind of list.", "min": 0, "max": "1", "base": { "path": "List.title", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Dr. Jane's Patients" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" } ] }, { "id": "List.code", "path": "List.code", "short": "What the purpose of this list is", "definition": "This code defines the purpose of the list - why it was created.", "comment": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.", "requirements": "Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.", "min": 0, "max": "1", "base": { "path": "List.code", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListPurpose" } ], "strength": "example", "description": "What the purpose of a list is", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-example-codes" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] }, { "id": "List.subject", "path": "List.subject", "short": "If all resources have the same subject", "definition": "The common subject (or patient) of the resources that are in the list, if there is one.", "comment": "Some purely arbitrary lists do not have a common subject, so this is optional.", "requirements": "The primary purpose of listing the subject explicitly is to help with finding the right list.", "min": 0, "max": "1", "base": { "path": "List.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode 1" } ] }, { "id": "List.note", "path": "List.note", "short": "Comments about the list", "definition": "Comments that apply to the overall list.", "min": 0, "max": "*", "base": { "path": "List.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].act.text" } ] }, { "id": "List.entry", "path": "List.entry", "short": "Medicine list entry", "definition": "List of medicine type entries", "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "min": 0, "max": "*", "base": { "path": "List.entry", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "lst-1" ], "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" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" } ] }, { "id": "List.entry.id", "path": "List.entry.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" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.entry.extension", "path": "List.entry.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "List.entry.extension:changeDescription", "path": "List.entry.extension", "sliceName": "changeDescription", "short": "Description of the change to the item", "definition": "Description of a change including the reason for change.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/change-description" } ], "condition": [ "ele-1" ], "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" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ] }, { "id": "List.entry.modifierExtension", "path": "List.entry.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.", "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, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "List.entry.flag", "path": "List.entry.flag", "short": "Medicine item change", "definition": "The flag allows the system constructing the list to indicate the role and significance of the item in the list.", "comment": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".", "requirements": "This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.", "min": 0, "max": "1", "base": { "path": "List.entry.flag", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/medicine-item-change" } }, "mapping": [ { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" } ] }, { "id": "List.entry.deleted", "path": "List.entry.deleted", "short": "If this item is actually marked as deleted", "definition": "True if this item is marked as deleted in the list.", "comment": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.\n\nThis element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.", "requirements": "The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as \"deleted\".", "min": 0, "max": "1", "base": { "path": "List.entry.deleted", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "lst-2" ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "added: .updateMode=(\"A\",\"AR\") retained: .updateMode=\"NC\" updated: .updateMode=\"R\" deleted: .updateMode=\"D\"" } ] }, { "id": "List.entry.date", "path": "List.entry.date", "short": "When item added to list", "definition": "When this item was added to the list.", "comment": "This is only useful and meaningful when the mode is \"working\".", "requirements": "The date may be significant for understanding the meaning of items in a working list.", "min": 0, "max": "1", "base": { "path": "List.entry.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": ".availabilityTime" } ] }, { "id": "List.entry.item", "path": "List.entry.item", "short": "Actual entry", "definition": "A reference to the actual resource from which data was derived.", "min": 1, "max": "1", "base": { "path": "List.entry.item", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationDispense" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Immunization" }, { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-norelevantfinding" } ], "mapping": [ { "identity": "rim", "map": ".target or .role or .role.entity" } ] }, { "id": "List.emptyReason", "path": "List.emptyReason", "short": "Why list is empty", "definition": "If the list is empty, why the list is empty.", "comment": "The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "min": 0, "max": "1", "base": { "path": "List.emptyReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "lst-1" ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListEmptyReason" } ], "strength": "preferred", "description": "If a list is empty, why it is empty", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-empty-reason" } }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]" } ] } ] }, "differential": { "element": [ { "id": "List", "path": "List", "short": "A list of medications in an Australian healthcare context" }, { "id": "List.extension", "path": "List.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "List.extension:sourceRole", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "draft" } ], "path": "List.extension", "sliceName": "sourceRole", "short": "Practitioner role that defined the list contents (aka Author)", "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/author-role" } ] }, { "id": "List.extension:sourceRelatedPerson", "path": "List.extension", "sliceName": "sourceRelatedPerson", "short": "Related person that defined the list contents (aka Author)", "definition": "The entity (related person) responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/author-related-person" } ] }, { "id": "List.entry", "path": "List.entry", "short": "Medicine list entry", "definition": "List of medicine type entries" }, { "id": "List.entry.extension", "path": "List.entry.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "List.entry.extension:changeDescription", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "draft" } ], "path": "List.entry.extension", "sliceName": "changeDescription", "short": "Description of the change to the item", "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/change-description" } ] }, { "id": "List.entry.flag", "path": "List.entry.flag", "short": "Medicine item change", "binding": { "strength": "preferred", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/medicine-item-change" } } }, { "id": "List.entry.item", "path": "List.entry.item", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationDispense" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Immunization" }, { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-norelevantfinding" } ] } ] } }