Skip to content

DetectedIssue Profile

Canonical../StructureDefinition/nexus-emr-core-detectedissue
Statusdraft (experimental) · 1.26.0
BaseDetectedIssue (constraint)
SourceFSH · JSON

Nexus EMR profile for DetectedIssue -- drug-drug and drug-allergy interaction findings raised during prescribing, and the prescriber's recorded override of them. First pass: models the override audit trail; the severity mapping is not yet settled.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

DetectedIssue

Short Nexus EMR DetectedIssue Core
Definition A clinical safety issue detected during prescribing -- a drug-drug or drug-allergy interaction -- together with the prescriber's decision about it. Produced by the interaction screening layer, and written back when a prescriber overrides.
Cardinality 0..*
Invariants dom-2, dom-3, dom-4, dom-5, dom-6, detectedissue-mitigation-has-rationale
Also called DDI, drug-drug interaction, Contraindication, Alert

DetectedIssue.id

Short Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

DetectedIssue.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.
Cardinality 0..1
Type Meta
Invariants ele-1

DetectedIssue.meta.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

DetectedIssue.meta.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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

DetectedIssue.meta.versionId

Short Version specific identifier
Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Cardinality 0..1
Type id
Invariants ele-1

DetectedIssue.meta.lastUpdated

Short When the resource version last changed
Definition When the resource last changed - e.g. when the version changed.
Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Cardinality 0..1
Type instant
Invariants ele-1

DetectedIssue.meta.source

Short Identifies EMR instance & pipeline version the resource came from
Definition A URI that identifies the EMR pipeline and version from which this resource originated. This tells you which EMR instance (recommend using the instance identifier), and the version of the pipeline code/transformations.
Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Cardinality 0..1
Type uri
Must Support yes
Invariants ele-1

DetectedIssue.meta.profile

Short Profiles this resource claims to conform to
Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Cardinality 0..*
Type canonical
Invariants ele-1

DetectedIssue.meta.security

Short Security Labels applied to this resource
Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Cardinality 0..*
Type Coding
Binding security-labels (extensible)
Invariants ele-1

DetectedIssue.meta.tag

Short Tags applied to this resource
Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Cardinality 0..*
Type Coding
Binding common-tags (example)
Invariants ele-1

DetectedIssue.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.
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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.
Cardinality 0..1
Type uri
Modifier yes — 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
Invariants ele-1

DetectedIssue.language

Short Language of the resource content
Definition The base language in which the resource is written.
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Cardinality 0..1
Type code
Binding languages (preferred)
Invariants ele-1

DetectedIssue.text

Short Narrative
Definition A human-readable narrative summary of the NexusEmrCoreDetectedIssue resource for human interpretation.
Comments 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 information is added later.
Cardinality 0..1
Type Narrative
Must Support yes
Invariants ele-1
Also called narrative, html, xhtml, display

DetectedIssue.contained

Short Contained, inline Resources
Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Cardinality 0..*
Type Resource
Also called inline resources, anonymous resources, contained resources

DetectedIssue.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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

DetectedIssue.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 and/or the understanding of the containing element's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Invariants ele-1, ext-1
Also called extensions, user content

DetectedIssue.identifier

Short Business identifier(s) for the detected issue
Definition Unique identifiers for the detected issue. A business identifier is recommended but not required (identifier is 0..*). Where available, carry the source-system identifier using the most appropriate system URI. No specific canonical system is mandated. If no recognized system exists, implementers MAY invent a URI for the system.
Requirements Allows linking instances of the same detected issue found on different servers.
Comments A source system's own identifier SHOULD be carried alongside this one, flagged use = secondary. See Carrying the raw code.
Cardinality 0..*
Type Identifier
Invariants ele-1

DetectedIssue.identifier.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

DetectedIssue.identifier.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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

DetectedIssue.identifier.use

Short usual | official | temp | secondary | old (If known)
Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Cardinality 0..1
Type code
Modifier yes — This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Binding identifier-use (required)
Invariants ele-1

DetectedIssue.identifier.type

Short Description of identifier
Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Cardinality 0..1
Type CodeableConcept
Binding identifier-type (extensible)
Invariants ele-1

DetectedIssue.identifier.system

Short The namespace for the identifier value
Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Cardinality 1..1
Type uri
Invariants ele-1

DetectedIssue.identifier.value

Short The value that is unique
Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Cardinality 1..1
Type string
Invariants ele-1

DetectedIssue.identifier.period

Short Time period when id is/was valid for use
Definition Time period during which identifier is/was valid for use.
Cardinality 0..1
Type Period
Invariants ele-1

DetectedIssue.identifier.assigner

Short Organization that issued id (may be just text)
Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Cardinality 0..1
Type Reference(Organization)
Invariants ele-1

DetectedIssue.status

Short registered | preliminary | final | amended | ... (observation-status)
Definition Indicates the status of the detected issue.
Comments The Rx module writes final for a screening result it stands behind. This element is NOT the override axis -- an overridden issue stays final and gains a mitigation; it does not become cancelled. Readers must not infer 'resolved' from status.
Cardinality 1..1
Type code
Must Support yes
Modifier yes — This element is labeled 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
Binding observation-status (required)
Invariants ele-1
Also called status

DetectedIssue.code

Short The kind of issue detected (drug-drug interaction, drug-allergy, etc.)
Definition Identifies the general type of issue identified.
Comments Currently written text-only by the screening layer. Text-only is conformant (CodeableConcept), so readers MUST NOT index positionally into code.coding -- see the text-only-concept rule. Coding this against detectedissue-category is first-pass follow-up, not settled.
Cardinality 0..1
Type CodeableConcept
Must Support yes
Binding detectedissue-category (preferred)
Invariants ele-1
Also called type

DetectedIssue.severity

Short high | moderate | low
Definition Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
Comments ⚠ FIRST PASS -- NOT SETTLED. The screening engine has its own severity scale and the mapping onto the R4 detectedissue-severity required binding has not been agreed. Do not treat the current values as a contract.
Cardinality 0..1
Type code
Must Support yes
Binding detectedissue-severity (required)
Invariants ele-1
Also called severity

DetectedIssue.patient

Short The patient the issue was detected for
Definition Indicates the patient whose record the detected issue is associated with.
Requirements While the subject could be inferred by tracing the subject of the implicated resources, it's useful to have a direct link for query purposes.
Comments 0..1 in R4 and left as such: a screening result computed before a patient context is established (e.g. a drug-pair lookup) legitimately has none. Anything persisted against a chart SHOULD carry it.
Cardinality 0..1
Type Reference(Patient Profile)
Must Support yes
Invariants ele-1

DetectedIssue.identified[x]

Short When identified
Definition The date or period when the detected issue was initially identified.
Requirements No-one can be responsible for mitigation prior to the issue being identified.
Cardinality 0..1
Type dateTime, Period
Invariants ele-1

DetectedIssue.author

Short The provider or device that identified the issue
Definition Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
Cardinality 0..1
Type Reference(Practitioner | PractitionerRole | Device)
Invariants ele-1

DetectedIssue.implicated

Short The medication/allergy resources whose combination raised this issue
Definition Indicates the resource representing the current activity or proposed activity that is potentially problematic.
Comments For a drug-drug interaction this is the two or more MedicationRequests; for drug-allergy, the MedicationRequest and the AllergyIntolerance. Per the Nexus EMR logical-reference model these MAY be identifier-only, so consumers must not assume a resolvable literal reference.
Cardinality 0..*
Type Reference(Resource)
Must Support yes
Invariants ele-1
Also called cause

DetectedIssue.evidence

Short Supporting evidence
Definition Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.
Cardinality 0..*
Type BackboneElement
Invariants ele-1

DetectedIssue.evidence.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

DetectedIssue.evidence.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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

DetectedIssue.evidence.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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 and/or the understanding of the containing element's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

DetectedIssue.evidence.code

Short Manifestation
Definition A manifestation that led to the recording of this detected issue.
Cardinality 0..*
Type CodeableConcept
Binding manifestation-or-symptom (example)
Invariants ele-1

DetectedIssue.evidence.detail

Short Supporting information
Definition Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.
Cardinality 0..*
Type Reference(Resource)
Invariants ele-1

DetectedIssue.detail

Short Description and context
Definition A textual explanation of the detected issue.
Comments Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.
Cardinality 0..1
Type string
Invariants ele-1

DetectedIssue.reference

Short Authority for issue
Definition The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
Cardinality 0..1
Type uri
Invariants ele-1

DetectedIssue.mitigation

Short The prescriber's recorded decision to proceed despite the issue
Definition The action taken about the detected issue. In this EMR a mitigation means a human overrode the warning and proceeded, and mitigation.action.text carries the rationale they gave. This is a medico-legal record. It is written in the same transaction bundle as the MedicationRequest it concerns, so the prescription and the reason for accepting its risk are committed together or not at all.
Comments ⚠ Cross-consumer convention, and the reason this profile exists: the PRESENCE of a mitigation is what marks an issue as accepted/overridden. status does NOT change. A reader that filters on status will show overridden interactions as live warnings.
Cardinality 0..*
Type BackboneElement
Must Support yes
Invariants ele-1

DetectedIssue.mitigation.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

DetectedIssue.mitigation.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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

DetectedIssue.mitigation.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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 and/or the understanding of the containing element's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

DetectedIssue.mitigation.action

Short What was done -- carries the override rationale in .text
Definition Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
Comments Text-only is the current shape and is conformant. Readers must handle a CodeableConcept with no coding.
Cardinality 1..1
Type CodeableConcept
Must Support yes
Binding detectedissue-mitigation-action (preferred)
Invariants ele-1

DetectedIssue.mitigation.date

Short When the override was recorded
Definition Indicates when the mitigating action was documented.
Comments This might not be the same as when the mitigating step was actually taken.
Cardinality 0..1
Type dateTime
Must Support yes
Invariants ele-1

DetectedIssue.mitigation.author

Short The practitioner who overrode
Definition Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.
Comments Practitioner is the primary provider identity in this IG; PractitionerRole is permitted where the clinic/role binding is part of the assertion. SHOULD be populated -- an override with no attributable author is a weak medico-legal record even when the rationale is present.
Cardinality 0..1
Type Reference(Practitioner Profile | PractitionerRole Profile)
Must Support yes
Invariants ele-1