PrescribeIT™ Specification and Guide Version 2.0 Revision F

This is the sixth publication for v2.0 (Revision F). The first version was published on 2017-08-17, the second version (Revision B) was published on 2017-10-17, the third version (Revision C) was published on 2018-01-09, the fourth version (Revision D) was published on 2018-02-02, and the fifth version (Revision E) was published on 2018-04-24.

2.1.1 Revision F Publication 2019-02-22

• Substantive (potentially breaking) Changes
  • None
• Non-Substantive Changes
  • In PrescribeIT™ Medication, aligned Medication.code.text and Medication.code.text with Medication.code.coding.display max Length of 1000.
  • In Shared Services Message Header, updated MessageHeader.timestamp comments to require full datetime.
  • In PrescribeIT™ Prescription, updated MedicationOrder.dosageInstruction.timing definitions and comments, MedicationOrder.dosageInstruction.route comments, and updated MedicationOrder.dateWritten and MedicationOrder.dispenseRequest.validityPeriod comments to require full datetime.
  • In Organization read response, updated example to include Organization.partOf.reference.
  • In 305 Clinician Communication - Locum to Organization, updated example to include relevant Locum elements and values.
  • In Shared Health Message Header, updated MessageHeader.source.endpoint and MessageHeader.destination.endpoint comments.
  • In PrescribeIT™ API Summary and Shared Health API Summary, clarified that the entire endpoint URL must be configurable.
  • In PrescribeIT Clinician Communication, updated Communication.subject.reference, extension(topic) and extension(topicRequisition) comments.
  • In PrescribeIT Formulary Operation Output, updated Parameters.parameter.part.valueCoding.display comments.
  • In Interaction Bundle - Organization Query and Interaction Bundle - Practitioner Query, included PR parameter's minimum search characters.
  • In Interaction Message Header 101 - Execute tasks from prescriber office, updated MessageHeader.source.extension(applicationId) comments to indicate that PrescribeIT assigns this value.
  • In PrescribeIT™ API Summary, updated Required Request Headers with developer key header information and updated RequestToken with correct Response Header from Services values
  • In Interaction Bundle - Practitioner Query, corrected 'telecom-phone:exact' description.
  • In Shared Health Operation Outcome, updated OperationOutcome.issue.diagnostics comments.
  • In RequestToken, updated Request With LicenseNumber example with correct PR elements
  • In Artifacts, fixed broken profile download links.
  • In Interaction Bundle 901 - Message disposition notification, updated the introduction to remove reference to Bundle.id.
  • In Shared Health CodeableConcept Code Required with Text Optional, updated CodeableConcept comment.
  • In Medication Order Protocol extension, updated comments.
  • In PrescribeIT™ Implementation Guide, added Production Configuration Values section.
  • In Interaction Bundle 101 - Execute tasks from physician office, updated Bundle.id comments.
  • In Interaction Message Header 101 - Execute tasks from prescriber office, updated MessageHeader.id comments.
  • ​In PrescribeIT Prescription, PrescribeIT New Prescription, and PrescribeIT Renewal Prescription updated Scope and Usage with respective Tasks.
  • In Task e162-m - RX Renewal Response - Approved and Task e163-m - RX Renewal Response - Approved with Changes, updated main definitions.

2.1.2 Revision E Publication 2018-04-24

• Substantive (potentially breaking) Changes
  • None.
  .
• Non-Substantive Changes
  • In PrescribeIT™ Implementation Guide, updated Product Overview, Understanding the Message Structure, and General Conformance and Usage Rules sections to clarify and enhance understanding.
  • In Deferred Messages, corrected Deferred Query examples.
  • In Interaction Bundle 305 - Send Clinician communication, added Shared Health Locum Practitioner link.
  • In Interaction Bundle 401 - Execute deferred tasks from an EMR, aligned profile name to be internally consistent within the VIG.
  • In PrescribeIT™ Prescription, updated MedicationOrder.dosageInstruction.timing definitions and conformance rules.
  • In PrescribeIT™ Renewal Prescription, aligned MedicationOrder.priorPrescription comments.
  • In PrescribeIT™ API Summary, updated Summary, RequestOTP and RequestToken sections and removed unsupported eFax Service section. In Shared Health API Summary, updated Summary, PR Get and PR Search sections. Details can be found in the API Summary document that will be issued as part of configuration package which vendors will receive as part of the process of connecting to the testing environments.
  • In Shared Health Message Header, removed extraneous MessageHeader.source extension.
  • In Interaction Bundle - Practitioner Query, corrected Group No 4 Practitioner Search By Discrete fields example.
  • In FHIR Validator, fixed broken Artifact link to correct modified "wrapper" version of generic HL7 validator jar that is being used by Central Switch and added instructions to use the complete validator-infowayvocab_2.0.x.pack name (i.e. with version suffix).
  • In both PrescribeIT™ and Shared Health Implementation Guide, clarified conformance rules (e.g. Task.extension (ext-task-requisition-id), removed unnecessary diagrams (e.g. Interaction 101 and 201) as existing EMR and PMS Task diagrams contain the useful resource relationships, removed conflicting (e.g. incorrect fixed value) and unnecesary comments (e.g. reference to HL7 v3), and enriched comments with real world business case examples (e.g. MedicationOrder.dispenseRequest.extension (http://PrescribeIT™.ca/fhir/StructureDefinition/ext-medicationorder-dispense-interval) to increase conformance clarity.
  • In both PrescribeIT™ and Shared Health VIG, aligned examples (e.g. List - Allergies profile) to v2.0 message specification.
  • In PrescribeIT™ VIG, separated 305 Clinician Communication example into 3 scenario instances, including 1) Locum sending on behalf of; 2) Prescriber sending; and 3) Pharmacy sending.
  .

2.1.3 Revision D Publication 2018-02-02

• Substantive (potentially breaking) Changes
  • None.
  .
• Non-Substantive Changes
  • In FHIR Validator, fixed broken Artifact links for validator jar, Shared Health pack, and PrescribeIT™ pack.
  • In both PrescribeIT™ and Shared Health Implementation Guide, improved text readability of examples and tables.
  .

2.1.4 Revision C Publication 2018-01-09

• Substantive (potentially breaking) Changes
  • In PrescribeIT™ Clinician Communication, nested Communication.sender.extension (http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of) directly under Communication.sender and Communication.recipient.
  • In Task e140-m - Cancel RX Fill Request Task.extension (http://PrescribeIT™.ca/fhir/StructureDefinition/ext-task-reason), changed the PrescriptionCancelReason binding from extensible to required.
  • In Task p160-m - RX Renewal Create Request, changed Task.input(instruction) name from 'sharedinstruction' to 'instruction' in order to handle the following in the p-160 message: 1) Addition of renewal comments that apply to all medication orders within a single renewal request bundle, and 2)Addition of a renewal comment that applies only to a specific medication within a single renewal request bundle.
  • In PrescribeIT™ Drug Quantity, changed Quantity.unit cardinality to 1..1, Quantity.system cardinality to 0..1, Quantity.code to 0..1 and updated related comments.
  • In PrescribeIT™ Drug Quantity for Administration, changed Quantity.unit cardinality to 1..1, Quantity.system cardinality to 0..1, Quantity.code to 0..1 and updated related comments.
  • In PrescribeIT™ Medication, changed Medication.product.form datatype to Shared Health CodeableConcept Required Text with optional code.
  • ​Removed the date anchor for the following PrescribeIT™ Terminology Value Sets to allow for the latest codes to be used without the need to publish another message specification
    • Communication Category.
    • Cancel Reason.
    • Prescription Drug Form.
    • Dose Quantity Unit.
    • Prescribed Quantity Unit.
    • Prescription Renewal Rejection Reason.
    • Prescription Renewal Review Reason.
    • Shared Issue Details.
    • Prescription Type.
    • Shared Identifier Type.
    • Shared Organization Type.
    • Shared Practitioner Identifier Type.
    • Shared Practitioner Role.
    .
  • In Medication Order Total Prescribed Days Supply and MedicationOrder.dispenseRequest.extension (http://PrescribeIT™.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply), updated the comments.
  • In PrescribeIT™ Prescription, updated MedicationOrder.identifier to a cardinality of 1..3, MedicationOrder.identifier(emr-id) to a cardinality of 1..1, and MedicationOrder.identifier(dis-id), to a cardinality of 0..2.
  • In PrescribeIT™ Prescription, changed MedicationOrder.dosageInstruction.rate[x] datatype from Quantity to Ratio. Made both numerator and denominator mandatory.
  • In PrescribeIT™ Prescription, changed MedicationOrder.dispenseRequest.extension (http://PrescribeIT™.ca/fhir/StructureDefinition/ext-medicationorder-total-prescribed-quantity) to a cardinality of 0..1.
  • In PrescribeIT™ DUR, changed DetectedIssue.mitigation.action datatype to Shared Health CodeableConcept Required Text with optional code.
  • In PrescribeIT™ Dispense, changed MedicationDispense.identifier datatype to Shared Health Identifier.
  • In Shared Health Identifier, updated Identifier.system to a cardinality of 1..1.
  • In Shared Health Practitioner, changed Practitioner.practitionerRole.specialty datatype to Shared Health CodeableConcept Required Text with optional code.
  • In Shared Health SAML Practitioner, updated Practitioner.extension (http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml) to 1..1.
  • In Shared Health Operation Outcome, declared slice names for OperationOutcome.issue.extension (http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-referencenum) and OperationOutcome.issue.extension (http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext).
  • In API Summary, updated Summary section.
  .
• Non-Substantive Changes
  • In Understanding Formal Views of Profile Content, added section describing the differences between the Grid View, Data Dictionary, and Snapshot Table.
  • In Task e161-m - RX Renewal Response - Denied and Task e164-m - RX Renewal Response - Under Review, updated Task.extension (http://PrescribeIT™.ca/fhir/StructureDefinition/ext-task-reason), updated Task.subject.reference comments.
  • In Task e162-m - RX Renewal Response - Approved and Task e163-m - RX Renewal Response - Approved with Changes , updated Task.extension (http://PrescribeIT™.ca/fhir/StructureDefinition/ext-task-reason), updated Task.subject.reference comments.
  • In Shared Health Operation Outcome, updated comments.
  • In Exception and Error Handling, updated section.
  • In RequestToken, updated Response Header from Service value.
  • In Interaction Message Header 101 - Execute tasks from prescriber office and Interaction Message Header 201 - Execute tasks from pharmacy, updated MessageHeader.source.endpoint and MessageHeader.destination.endpoint comments.
  • In Interaction Message Header 401 - Execute deferred tasks from prescriber office, updated MessageHeader.source.endpoint and MessageHeader.destination.endpoint comments.
  • In both PrescribeIT™ and Shared Health Implementation Guide, clarified section examples and removed unecessary comments.
  • In both PrescribeIT™ and Shared Health, aligned examples (e.g. e140, 305, and OperationOutcome snippets) to v2.0 message specification.
  .