This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
StructureDefinition for contraindication
{
"resourceType": "StructureDefinition",
"id": "Contraindication",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Contraindication",
"name": "Contraindication",
"publisher": "HL7 FHIR Project (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Contraindication Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Contraindication",
"short": "Clinical issue with action",
"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.",
"alias": [
"DDI",
"drug-drug interaction",
"DetectedIssue",
"Alert"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Contraindication"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Observation[classCode=ALRT, moodCode=EVN)"
}
]
},
{
"path": "Contraindication.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. 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. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Contraindication.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Contraindication.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.",
"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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Contraindication.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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Contraindication.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Contraindication.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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.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. 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.patient",
"short": "Associated patient",
"definition": "Indicates the patient whose record the contraindication 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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Contraindication.category",
"short": "E.g. Drug-drug, duplicate therapy, etc.",
"definition": "Identifies the general type of issue identified.",
"alias": [
"type"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationCategory",
"strength": "required",
"description": "Codes identifying the general type of contraindication. E.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.severity",
"short": "high | medium | low",
"definition": "Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.",
"alias": [
"severity"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationSeverity",
"strength": "required",
"description": "Indicates the potential degree of impact of the identified issue on the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SeverityObservation"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV].value"
}
]
},
{
"path": "Contraindication.implicated",
"short": "Problem resource",
"definition": "Indicates the resource representing the current activity or proposed activity that.",
"comments": "There's an implicit constraint on the number of implicated resources based on Contraindication.type. E.g. For drug-drug, there would be more than one. For timing, there would typically only be one.",
"alias": [
"cause"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[moodCode=EVN, INT]"
}
]
},
{
"path": "Contraindication.detail",
"short": "Description and context",
"definition": "A textual explanation of the contraindication.",
"comments": "Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Contraindication.date",
"short": "When identified",
"definition": "The date or date-time when the contraindication was initially identified.",
"requirements": "No-one can be responsible for mitigation prior to the issue being identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.author",
"short": "Who found issue?",
"definition": "Identifies the provider or software that identified the.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
},
{
"path": "Contraindication.identifier",
"short": "Unique id for the contraindication",
"definition": "Business identifier associated with the contraindication record.",
"requirements": "Allows linking instances of the same contraindication found on different servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Contraindication.reference",
"short": "Authority for issue",
"definition": "The literature, knowledge-base or similar reference that describes the propensity for the contraindication identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=INST].target[classCode=ALRT, moodCode=DEFN].text.uri"
}
]
},
{
"path": "Contraindication.mitigation",
"short": "Step taken to address",
"definition": "Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the contraindicaiton from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=MITG].target[classCode=ACT, moodCode=EVN]"
}
]
},
{
"path": "Contraindication.mitigation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contraindication.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. 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contraindication.mitigation.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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.mitigation.action",
"short": "What mitigation?",
"definition": "Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified contraindication.",
"comments": "The \"text\" component can be used for detail or when no appropriate code exists.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContraindicationMitigationAction",
"strength": "required",
"description": "Codes describing steps taken to resolve the contraindication or other circumstances that mitigate the risk associated with the contraindication. E.g. 'added concurrent therapy', 'prior therapy documented', etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-mitigation-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.mitigation.date",
"short": "Date committed",
"definition": "Indicates when the mitigating action was documented.",
"comments": "This may not be the same as when the mitigating step was actually taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.mitigation.author",
"short": "Who is committing?",
"definition": "Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Contraindication",
"short": "Clinical issue with action",
"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.",
"alias": [
"DDI",
"drug-drug interaction",
"DetectedIssue",
"Alert"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Observation[classCode=ALRT, moodCode=EVN)"
}
]
},
{
"path": "Contraindication.patient",
"short": "Associated patient",
"definition": "Indicates the patient whose record the contraindication 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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Contraindication.category",
"short": "E.g. Drug-drug, duplicate therapy, etc.",
"definition": "Identifies the general type of issue identified.",
"alias": [
"type"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationCategory",
"strength": "required",
"description": "Codes identifying the general type of contraindication. E.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.severity",
"short": "high | medium | low",
"definition": "Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.",
"alias": [
"severity"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationSeverity",
"strength": "required",
"description": "Indicates the potential degree of impact of the identified issue on the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SeverityObservation"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV].value"
}
]
},
{
"path": "Contraindication.implicated",
"short": "Problem resource",
"definition": "Indicates the resource representing the current activity or proposed activity that.",
"comments": "There's an implicit constraint on the number of implicated resources based on Contraindication.type. E.g. For drug-drug, there would be more than one. For timing, there would typically only be one.",
"alias": [
"cause"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[moodCode=EVN, INT]"
}
]
},
{
"path": "Contraindication.detail",
"short": "Description and context",
"definition": "A textual explanation of the contraindication.",
"comments": "Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Contraindication.date",
"short": "When identified",
"definition": "The date or date-time when the contraindication was initially identified.",
"requirements": "No-one can be responsible for mitigation prior to the issue being identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.author",
"short": "Who found issue?",
"definition": "Identifies the provider or software that identified the.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
},
{
"path": "Contraindication.identifier",
"short": "Unique id for the contraindication",
"definition": "Business identifier associated with the contraindication record.",
"requirements": "Allows linking instances of the same contraindication found on different servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Contraindication.reference",
"short": "Authority for issue",
"definition": "The literature, knowledge-base or similar reference that describes the propensity for the contraindication identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=INST].target[classCode=ALRT, moodCode=DEFN].text.uri"
}
]
},
{
"path": "Contraindication.mitigation",
"short": "Step taken to address",
"definition": "Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the contraindicaiton from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=MITG].target[classCode=ACT, moodCode=EVN]"
}
]
},
{
"path": "Contraindication.mitigation.action",
"short": "What mitigation?",
"definition": "Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified contraindication.",
"comments": "The \"text\" component can be used for detail or when no appropriate code exists.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContraindicationMitigationAction",
"strength": "required",
"description": "Codes describing steps taken to resolve the contraindication or other circumstances that mitigate the risk associated with the contraindication. E.g. 'added concurrent therapy', 'prior therapy documented', etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-mitigation-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.mitigation.date",
"short": "Date committed",
"definition": "Indicates when the mitigating action was documented.",
"comments": "This may not be the same as when the mitigating step was actually taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.mitigation.author",
"short": "Who is committing?",
"definition": "Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
}
]
}
}
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 DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:19+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change