PrescribeIT™ Specification and Guide Version 2.0 Revision F

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/profile-detectedissue

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from DetectedIssue

NameCard.TypeConstraints and Usage
.  DetectedIssue 0..*Definition:
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.


Comments:
Usage Note: Detected Issue will be used to convey managed drug interactions.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this issue instance.

..  patient 1..1Reference(Shared Health Patient) {b}Definition:
A reference from one resource to another.

..  category 0..1Shared Health CodeableConcept TextBinding: Detected Issue Category (preferred)
inv-1: Must have coding or text but not both
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
This is used to express the type of interaction and is supported with a binding value set. As a data type of codeable concept, coding and text are both available, optionally to express.

Conformance Rule: Drug Interactions should be populated when available.

Usage Note: PMS systems who are using the same DUR database could make use of this code for linking and presentation purposes

..  implicated 1..1Reference(PrescribeIT Prescription) {b}Definition:
A reference from one resource to another.


Comments:
There's an implicit constraint on the number of implicated resources based on DetectedIssue.type; e.g. For drug-drug, there would be more than one. For timing, there would typically only be one.

..  detail 0..1stringMax Length: 1000
Definition:
A textual explanation of the detected issue.


Comments:
Conformance Rule: The EMR can determine which warnings should be sent, with a caution that too many warnings may not be useful. For example: Instead of sending all warnings, the Prescriber or EMR could be only the severe warnings and/or any warnings that the Prescriber specifically handled. Refer to rules in 'mitigation.action'. If an issue is provided, there is the expectation that a mitigation is also stated.

Conformance Rule: Maximum character length set to ‘1000’.

..  mitigation 0..*BackboneElementDefinition:
Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.


Comments:
Mitigation is used to express the steps taken to 'mitigate' the impact of the DUR issue. If used, 'action' is mandatory, of which only the child element of 'text' must be valued.

Conformance Rule: Must be provided as available. Expected to be available for each DUR code as only those that have been managed will be submitted in the message

Conformance Rule: The PMS MUST display all warnings with Managed Text.

...  action 1..1Shared Health CodeableConcept Required Text with optional codeBinding: Detected Issue Mitigation Action (preferred)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Usage Note: Text is mandatory. Coding is optional. If a code is available, it must be sent in Coding. Code + System are mandatory if coding is present.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DetectedIssue S0..*Clinical issue with action
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... patient SΣ1..1Reference(Shared Health Patient) {b}A reference from one resource to another
... category SI0..1Shared Health CodeableConcept TextConcept - reference to a terminology or just text
Binding: Detected Issue Category (preferred)
... severity Σ0..1codehigh | moderate | low
Binding: DetectedIssueSeverity (required)
... implicated SΣ1..1Reference(PrescribeIT Prescription) {b}A reference from one resource to another
... detail S0..1stringDescription and context
Max Length: 1000
... date Σ0..1dateTimeWhen identified
... author Σ0..1Reference(Practitioner | Device)The provider or device that identified the issue
... identifier Σ0..1IdentifierUnique id for the detected issue
... reference 0..1uriAuthority for issue
... mitigation S0..*BackboneElementStep taken to address
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... action S1..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: Detected Issue Mitigation Action (preferred)
.... date 0..1dateTimeDate committed
.... author 0..1Reference(Practitioner)Who is committing?

doco Documentation for this format

Grid View

This structure is derived from DetectedIssue

NameCard.TypeConstraints and Usage
.  DetectedIssue 0..*Definition:
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.


Comments:
Usage Note: Detected Issue will be used to convey managed drug interactions.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this issue instance.

..  patient 1..1Reference(Shared Health Patient) {b}Definition:
A reference from one resource to another.

..  category 0..1Shared Health CodeableConcept TextBinding: Detected Issue Category (preferred)
inv-1: Must have coding or text but not both
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
This is used to express the type of interaction and is supported with a binding value set. As a data type of codeable concept, coding and text are both available, optionally to express.

Conformance Rule: Drug Interactions should be populated when available.

Usage Note: PMS systems who are using the same DUR database could make use of this code for linking and presentation purposes

..  implicated 1..1Reference(PrescribeIT Prescription) {b}Definition:
A reference from one resource to another.


Comments:
There's an implicit constraint on the number of implicated resources based on DetectedIssue.type; e.g. For drug-drug, there would be more than one. For timing, there would typically only be one.

..  detail 0..1stringMax Length: 1000
Definition:
A textual explanation of the detected issue.


Comments:
Conformance Rule: The EMR can determine which warnings should be sent, with a caution that too many warnings may not be useful. For example: Instead of sending all warnings, the Prescriber or EMR could be only the severe warnings and/or any warnings that the Prescriber specifically handled. Refer to rules in 'mitigation.action'. If an issue is provided, there is the expectation that a mitigation is also stated.

Conformance Rule: Maximum character length set to ‘1000’.

..  mitigation 0..*BackboneElementDefinition:
Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.


Comments:
Mitigation is used to express the steps taken to 'mitigate' the impact of the DUR issue. If used, 'action' is mandatory, of which only the child element of 'text' must be valued.

Conformance Rule: Must be provided as available. Expected to be available for each DUR code as only those that have been managed will be submitted in the message

Conformance Rule: The PMS MUST display all warnings with Managed Text.

...  action 1..1Shared Health CodeableConcept Required Text with optional codeBinding: Detected Issue Mitigation Action (preferred)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Usage Note: Text is mandatory. Coding is optional. If a code is available, it must be sent in Coding. Code + System are mandatory if coding is present.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DetectedIssue S0..*Clinical issue with action
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... patient SΣ1..1Reference(Shared Health Patient) {b}A reference from one resource to another
... category SI0..1Shared Health CodeableConcept TextConcept - reference to a terminology or just text
Binding: Detected Issue Category (preferred)
... severity Σ0..1codehigh | moderate | low
Binding: DetectedIssueSeverity (required)
... implicated SΣ1..1Reference(PrescribeIT Prescription) {b}A reference from one resource to another
... detail S0..1stringDescription and context
Max Length: 1000
... date Σ0..1dateTimeWhen identified
... author Σ0..1Reference(Practitioner | Device)The provider or device that identified the issue
... identifier Σ0..1IdentifierUnique id for the detected issue
... reference 0..1uriAuthority for issue
... mitigation S0..*BackboneElementStep taken to address
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... action S1..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: Detected Issue Mitigation Action (preferred)
.... date 0..1dateTimeDate committed
.... author 0..1Reference(Practitioner)Who is committing?

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
DetectedIssue.language?extrequiredhttp://tools.ietf.org/html/bcp47
DetectedIssue.categoryDetected Issue CategorypreferredDetected Issue Category
DetectedIssue.severityDetectedIssueSeverityrequiredDetectedIssueSeverity
DetectedIssue.mitigation.actionDetected Issue Mitigation ActionpreferredDetected Issue Mitigation Action

Constraints

IdPathDetailsRequirements
inv-1DetectedIssue.categoryMust have coding or text but not both
: coding.exists() xor text.exists()