This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
JSON Format: StructureDefinition-allergyintolerance-uv-ips
Raw json
{ "resourceType" : "StructureDefinition", "id" : "allergyintolerance-uv-ips", "meta" : { "lastUpdated" : "2018-02-15T01:58:02.283+11:00" }, "text" : { "status" : "generated", "div" : "<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-allergyintolerance-uv-ips-definitions.html#AllergyIntolerance.clinicalStatus" title="null">clinicalStatus</a><a name="AllergyIntolerance.clinicalStatus"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>" }, "url" : "http://hl7.org/fhir/uv/ips/StructureDefinition/allergyintolerance-uv-ips", "version" : "0.1.0", "name" : "AllergyIntolerance-uv-ips", "title" : "Allergy Intolerance", "status" : "draft", "date" : "2018-02-15T00:57:18+11:00", "description" : "This profile represents the constraints applied to the AllergyIntolerance resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile. It documents the relevant allergies or intolerances (conditions) for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.", "jurisdiction" : [ { "coding" : [ { "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001", "display" : "World" } ] } ], "purpose" : "This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.", "fhirVersion" : "3.0.1", "kind" : "resource", "abstract" : false, "type" : "AllergyIntolerance", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance", "derivation" : "constraint", "snapshot" : { "element" : [ { "id" : "AllergyIntolerance", "path" : "AllergyIntolerance", "short" : "Allergy or Intolerance (generally: Risk of adverse reaction to a substance)", "definition" : "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.", "comment" : "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.", "alias" : [ "Allergy", "Intolerance", "Adverse Reaction" ], "min" : 0, "max" : "*", "base" : { "path" : "Resource", "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)" }, { "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)" }, { "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))" }, { "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))]))" }, { "key" : "ait-1", "severity" : "error", "human" : "AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.", "expression" : "verificationStatus='entered-in-error' or clinicalStatus.exists()", "xpath" : "f:verificationStatus/@value='entered-in-error' or exists(f:clinicalStatus)" }, { "key" : "ait-2", "severity" : "error", "human" : "AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error", "expression" : "verificationStatus!='entered-in-error' or clinicalStatus.empty()", "xpath" : "f:verificationStatus/@value!='entered-in-error' or not(exists(f:clinicalStatus))" } ], "mapping" : [ { "identity" : "rim", "map" : "Entity. Role, or Act" }, { "identity" : "rim", "map" : "Observation[classCode=OBS, moodCode=EVN]" }, { "identity" : "w5", "map" : "clinical.general" } ] }, { "id" : "AllergyIntolerance.id", "path" : "AllergyIntolerance.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.", "comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "id" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.meta", "path" : "AllergyIntolerance.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", "base" : { "path" : "Resource.meta", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Meta" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.implicitRules", "path" : "AllergyIntolerance.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.", "comment" : "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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.implicitRules", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isModifier" : true, "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.language", "path" : "AllergyIntolerance.language", "short" : "Language of the resource content", "definition" : "The base language in which the resource is written.", "comment" : "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).", "min" : 0, "max" : "1", "base" : { "path" : "Resource.language", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference" : { "reference" : "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Language" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true } ], "strength" : "extensible", "description" : "A human language.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/languages" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.text", "path" : "AllergyIntolerance.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.", "comment" : "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 in formation is added later.", "alias" : [ "narrative", "html", "xhtml", "display" ], "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Narrative" } ], "condition" : [ "ele-1", "dom-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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.text?" } ] }, { "id" : "AllergyIntolerance.contained", "path" : "AllergyIntolerance.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.", "comment" : "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" : "*", "base" : { "path" : "DomainResource.contained", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Resource" } ], "mapping" : [ { "identity" : "rim", "map" : "Entity. Role, or Act" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.extension", "path" : "AllergyIntolerance.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.modifierExtension", "path" : "AllergyIntolerance.modifierExtension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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" } ], "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" }, { "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')])" } ], "isModifier" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier", "path" : "AllergyIntolerance.identifier", "short" : "External ids for this item", "definition" : "This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "min" : 0, "max" : "*", "base" : { "path" : "AllergyIntolerance.identifier", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Identifier" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity" : "rim", "map" : "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity" : "servd", "map" : "Identifier" }, { "identity" : "v2", "map" : "IAM-7" }, { "identity" : "rim", "map" : "id" }, { "identity" : "w5", "map" : "id" } ] }, { "id" : "AllergyIntolerance.identifier.id", "path" : "AllergyIntolerance.identifier.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.identifier.extension", "path" : "AllergyIntolerance.identifier.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier.use", "path" : "AllergyIntolerance.identifier.use", "short" : "usual | official | temp | secondary (If known)", "definition" : "The purpose of this identifier.", "comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min" : 0, "max" : "1", "base" : { "path" : "Identifier.use", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isModifier" : true, "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "IdentifierUse" } ], "strength" : "required", "description" : "Identifies the purpose for this identifier, if known .", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/identifier-use" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Role.code or implied by context" } ] }, { "id" : "AllergyIntolerance.identifier.type", "path" : "AllergyIntolerance.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.", "comment" : "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.", "requirements" : "Allows users to make use of identifiers when the identifier system is not known.", "min" : 0, "max" : "1", "base" : { "path" : "Identifier.type", "min" : 0, "max" : "1" }, "type" : [ { "code" : "CodeableConcept" } ], "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" } ], "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "IdentifierType" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true } ], "strength" : "extensible", "description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/identifier-type" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "v2", "map" : "CX.5" }, { "identity" : "rim", "map" : "Role.code or implied by context" } ] }, { "id" : "AllergyIntolerance.identifier.type.id", "path" : "AllergyIntolerance.identifier.type.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.identifier.type.extension", "path" : "AllergyIntolerance.identifier.type.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding", "path" : "AllergyIntolerance.identifier.type.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 0, "max" : "*", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.id", "path" : "AllergyIntolerance.identifier.type.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.extension", "path" : "AllergyIntolerance.identifier.type.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.system", "path" : "AllergyIntolerance.identifier.type.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.version", "path" : "AllergyIntolerance.identifier.type.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.code", "path" : "AllergyIntolerance.identifier.type.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.identifier.type.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.identifier.type.coding.userSelected", "path" : "AllergyIntolerance.identifier.type.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.identifier.type.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.identifier.type.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.identifier.system", "path" : "AllergyIntolerance.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.", "comment" : "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", "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.", "min" : 0, "max" : "1", "base" : { "path" : "Identifier.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "example" : [ { "label" : "General", "valueUri" : "http://www.acme.com/identifiers/patient" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX.4 / EI-2-4" }, { "identity" : "rim", "map" : "II.root or Role.id.root" }, { "identity" : "servd", "map" : "./IdentifierType" } ] }, { "id" : "AllergyIntolerance.identifier.value", "path" : "AllergyIntolerance.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.", "comment" : "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](extension-rendered-value.html).", "min" : 0, "max" : "1", "base" : { "path" : "Identifier.value", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "example" : [ { "label" : "General", "valueString" : "123456" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX.1 / EI.1" }, { "identity" : "rim", "map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity" : "servd", "map" : "./Value" } ] }, { "id" : "AllergyIntolerance.identifier.period", "path" : "AllergyIntolerance.identifier.period", "short" : "Time period when id is/was valid for use", "definition" : "Time period during which identifier is/was valid for use.", "comment" : "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.", "min" : 0, "max" : "1", "base" : { "path" : "Identifier.period", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Period" } ], "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" }, { "key" : "per-1", "severity" : "error", "human" : "If present, start SHALL have a lower value than end", "expression" : "start.empty() or end.empty() or (start <= end)", "xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "DR" }, { "identity" : "rim", "map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" }, { "identity" : "v2", "map" : "CX.7 + CX.8" }, { "identity" : "rim", "map" : "Role.effectiveTime or implied by context" }, { "identity" : "servd", "map" : "./StartDate and ./EndDate" } ] }, { "id" : "AllergyIntolerance.identifier.period.id", "path" : "AllergyIntolerance.identifier.period.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.identifier.period.extension", "path" : "AllergyIntolerance.identifier.period.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier.period.start", "path" : "AllergyIntolerance.identifier.period.start", "short" : "Starting time with inclusive boundary", "definition" : "The start of the period. The boundary is inclusive.", "comment" : "If the low element is missing, the meaning is that the low boundary is not known.", "min" : 0, "max" : "1", "base" : { "path" : "Period.start", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "condition" : [ "ele-1", "per-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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "DR.1" }, { "identity" : "rim", "map" : "./low" } ] }, { "id" : "AllergyIntolerance.identifier.period.end", "path" : "AllergyIntolerance.identifier.period.end", "short" : "End time with inclusive boundary, if not ongoing", "definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "min" : 0, "max" : "1", "base" : { "path" : "Period.end", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing", "condition" : [ "ele-1", "per-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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "DR.2" }, { "identity" : "rim", "map" : "./high" } ] }, { "id" : "AllergyIntolerance.identifier.assigner", "path" : "AllergyIntolerance.identifier.assigner", "short" : "Organization that issued id (may be just text)", "definition" : "Organization that issued/manages the identifier.", "comment" : "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.", "min" : 0, "max" : "1", "base" : { "path" : "Identifier.assigner", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization" } ], "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" }, { "key" : "ref-1", "severity" : "error", "human" : "SHALL have a contained resource if a local reference is provided", "expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity" : "v2", "map" : "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity" : "rim", "map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity" : "servd", "map" : "./IdentifierIssuingAuthority" } ] }, { "id" : "AllergyIntolerance.identifier.assigner.id", "path" : "AllergyIntolerance.identifier.assigner.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.identifier.assigner.extension", "path" : "AllergyIntolerance.identifier.assigner.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier.assigner.reference", "path" : "AllergyIntolerance.identifier.assigner.reference", "short" : "Literal reference, Relative, internal or absolute URL", "definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.reference", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "condition" : [ "ele-1", "ref-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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.identifier.assigner.identifier", "path" : "AllergyIntolerance.identifier.assigner.identifier", "short" : "Logical reference, when literal reference is not known", "definition" : "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.identifier", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Identifier" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity" : "rim", "map" : "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity" : "servd", "map" : "Identifier" }, { "identity" : "rim", "map" : ".identifier" } ] }, { "id" : "AllergyIntolerance.identifier.assigner.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.identifier.assigner.display", "short" : "Text alternative for the resource", "definition" : "Plain text narrative that identifies the resource in addition to the resource reference.", "comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.clinicalStatus", "path" : "AllergyIntolerance.clinicalStatus", "short" : "active | inactive | resolved", "definition" : "The clinical status of the allergy or intolerance.", "comment" : "This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as not currently valid.", "min" : 1, "max" : "1", "base" : { "path" : "AllergyIntolerance.clinicalStatus", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "condition" : [ "ele-1", "ait-1", "ait-2" ], "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" } ], "mustSupport" : true, "isModifier" : true, "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceClinicalStatus" } ], "strength" : "required", "description" : "The clinical status of the allergy or intolerance.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/allergy-clinical-status" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value" }, { "identity" : "w5", "map" : "status" } ] }, { "id" : "AllergyIntolerance.verificationStatus", "path" : "AllergyIntolerance.verificationStatus", "short" : "unconfirmed | confirmed | refuted | entered-in-error", "definition" : "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).", "comment" : "In the scope of the IPS the entered-in-error concept is not allowed.", "min" : 1, "max" : "1", "base" : { "path" : "AllergyIntolerance.verificationStatus", "min" : 1, "max" : "1" }, "type" : [ { "code" : "code" } ], "condition" : [ "ele-1", "ait-1", "ait-2" ], "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" } ], "mustSupport" : true, "isModifier" : true, "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceVerificationStatus" } ], "strength" : "required", "description" : "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/allergy-verification-status" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value" }, { "identity" : "w5", "map" : "status" } ] }, { "id" : "AllergyIntolerance.type", "path" : "AllergyIntolerance.type", "short" : "allergy | intolerance - Underlying mechanism (if known)", "definition" : "Identification of the underlying physiological mechanism for the reaction risk.", "comment" : "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.", "alias" : [ "Category", "Class" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.type", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "mustSupport" : true, "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceType" } ], "strength" : "required", "description" : "Identification of the underlying physiological mechanism for a Reaction Risk.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-type" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "IAM-9" }, { "identity" : "rim", "map" : "code" }, { "identity" : "w5", "map" : "class" } ] }, { "id" : "AllergyIntolerance.category", "path" : "AllergyIntolerance.category", "short" : "food | medication | environment | biologic", "definition" : "Category of the identified substance.", "comment" : "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.", "alias" : [ "Category", "Type", "Reaction Type", "Class" ], "min" : 0, "max" : "*", "base" : { "path" : "AllergyIntolerance.category", "min" : 0, "max" : "*" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCategory" } ], "strength" : "required", "description" : "Category of an identified substance.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-category" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "AL1-2" }, { "identity" : "rim", "map" : "value < IntoleranceValue (Agent)" }, { "identity" : "w5", "map" : "class" } ] }, { "id" : "AllergyIntolerance.criticality", "path" : "AllergyIntolerance.criticality", "short" : "low | high | unable-to-assess", "definition" : "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.", "comment" : "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.", "alias" : [ "Severity", "Seriousness", "Contra-indication", "Risk" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.criticality", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "mustSupport" : true, "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCriticality" } ], "strength" : "required", "description" : "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "AL1-4" }, { "identity" : "rim", "map" : "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" }, { "identity" : "w5", "map" : "grade" } ] }, { "id" : "AllergyIntolerance.code", "path" : "AllergyIntolerance.code", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "coding.system" } ], "rules" : "closed" }, "short" : "Code that identifies the allergy or intolerance", "definition" : "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies").", "comment" : "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.", "alias" : [ "Code" ], "min" : 1, "max" : "1", "base" : { "path" : "AllergyIntolerance.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "CodeableConcept" } ], "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" } ], "mustSupport" : true, "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCode" } ], "strength" : "example", "description" : "Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/allergyintolerance-code" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "v2", "map" : "AL1-3 / IAM-3" }, { "identity" : "rim", "map" : "substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value" }, { "identity" : "w5", "map" : "what" } ] }, { "id" : "AllergyIntolerance.code.id", "path" : "AllergyIntolerance.code.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.code.extension", "path" : "AllergyIntolerance.code.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.code.coding", "path" : "AllergyIntolerance.code.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 0, "max" : "*", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.code.coding.id", "path" : "AllergyIntolerance.code.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.code.coding.extension", "path" : "AllergyIntolerance.code.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.code.coding.system", "path" : "AllergyIntolerance.code.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.code.coding.version", "path" : "AllergyIntolerance.code.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.code.coding.code", "path" : "AllergyIntolerance.code.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.code.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.code.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.code.coding.userSelected", "path" : "AllergyIntolerance.code.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.code.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.code.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy", "path" : "AllergyIntolerance.code", "sliceName" : "absentOrUnknownAllergy", "short" : "Code for absent or unknown allergy or intolerance", "definition" : "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This describes a categorical negated statement (e.g., "No known allergy").", "comment" : "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.", "alias" : [ "Code" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "CodeableConcept", "profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" } ], "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" } ], "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCode" } ], "strength" : "required", "description" : "negation/exclusion codes for reporting no known allergies or not available data.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-allergies-uv-ips" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "v2", "map" : "AL1-3 / IAM-3" }, { "identity" : "rim", "map" : "substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value" }, { "identity" : "w5", "map" : "what" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.id", "path" : "AllergyIntolerance.code.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.extension", "path" : "AllergyIntolerance.code.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding", "path" : "AllergyIntolerance.code.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 1, "max" : "1", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.id", "path" : "AllergyIntolerance.code.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.extension", "path" : "AllergyIntolerance.code.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.system", "path" : "AllergyIntolerance.code.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 1, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "fixedUri" : "urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1", "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.version", "path" : "AllergyIntolerance.code.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.code", "path" : "AllergyIntolerance.code.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 1, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.code.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.userSelected", "path" : "AllergyIntolerance.code.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.code.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.code:default", "path" : "AllergyIntolerance.code", "sliceName" : "default", "short" : "Code that identifies the allergy or intolerance", "definition" : "Code for an allergy or intolerance statement . This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy").", "comment" : "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.", "alias" : [ "Code" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "CodeableConcept", "profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" } ], "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" } ], "isSummary" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCode" } ], "strength" : "preferred", "description" : "Type of the substance/product, allergy or intolerance condition.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "v2", "map" : "AL1-3 / IAM-3" }, { "identity" : "rim", "map" : "substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value" }, { "identity" : "w5", "map" : "what" } ] }, { "id" : "AllergyIntolerance.code:default.id", "path" : "AllergyIntolerance.code.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.code:default.extension", "path" : "AllergyIntolerance.code.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.code:default.coding", "path" : "AllergyIntolerance.code.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 0, "max" : "*", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.code:default.coding.id", "path" : "AllergyIntolerance.code.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.code:default.coding.extension", "path" : "AllergyIntolerance.code.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.code:default.coding.system", "path" : "AllergyIntolerance.code.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.code:default.coding.version", "path" : "AllergyIntolerance.code.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.code:default.coding.code", "path" : "AllergyIntolerance.code.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.code:default.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.code.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.code:default.coding.userSelected", "path" : "AllergyIntolerance.code.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.code:default.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.code.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.patient", "path" : "AllergyIntolerance.patient", "short" : "Who the sensitivity is for", "definition" : "The patient who has the allergy or intolerance.", "comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias" : [ "Patient" ], "min" : 1, "max" : "1", "base" : { "path" : "AllergyIntolerance.patient", "min" : 1, "max" : "1" }, "type" : [ { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Patient" } ], "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" }, { "key" : "ref-1", "severity" : "error", "human" : "SHALL have a contained resource if a local reference is provided", "expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mustSupport" : true, "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity" : "v2", "map" : "(PID-3)" }, { "identity" : "rim", "map" : ".participation[typeCode=SBJ].role[classCode=PAT]" }, { "identity" : "w5", "map" : "who.focus" } ] }, { "id" : "AllergyIntolerance.patient.id", "path" : "AllergyIntolerance.patient.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.patient.extension", "path" : "AllergyIntolerance.patient.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.patient.reference", "path" : "AllergyIntolerance.patient.reference", "short" : "Literal reference, Relative, internal or absolute URL", "definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.reference", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "condition" : [ "ele-1", "ref-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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.patient.identifier", "path" : "AllergyIntolerance.patient.identifier", "short" : "Logical reference, when literal reference is not known", "definition" : "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "min" : 0, "max" : "0", "base" : { "path" : "Reference.identifier", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Identifier" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity" : "rim", "map" : "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity" : "servd", "map" : "Identifier" }, { "identity" : "rim", "map" : ".identifier" } ] }, { "id" : "AllergyIntolerance.patient.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.patient.display", "short" : "Text alternative for the resource", "definition" : "Plain text narrative that identifies the resource in addition to the resource reference.", "comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.onsetDateTime:onsetDateTime", "path" : "AllergyIntolerance.onsetDateTime", "sliceName" : "onsetDateTime", "short" : "When allergy or intolerance was identified", "definition" : "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", "min" : 1, "max" : "1", "base" : { "path" : "AllergyIntolerance.onset[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "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" } ], "mustSupport" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "effectiveTime.low" }, { "identity" : "w5", "map" : "when.init" } ] }, { "id" : "AllergyIntolerance.assertedDate", "path" : "AllergyIntolerance.assertedDate", "short" : "Date record was believed accurate", "definition" : "The date on which the existance of the AllergyIntolerance was first asserted or acknowledged.", "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.assertedDate", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "IAM-20" }, { "identity" : "rim", "map" : ".participation[typeCode=AUT].time" }, { "identity" : "w5", "map" : "when.recorded" } ] }, { "id" : "AllergyIntolerance.recorder", "path" : "AllergyIntolerance.recorder", "short" : "Who recorded the sensitivity", "definition" : "Individual who recorded the record and takes responsibility for its content.", "comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias" : [ "Author" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.recorder", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Patient" } ], "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" }, { "key" : "ref-1", "severity" : "error", "human" : "SHALL have a contained resource if a local reference is provided", "expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity" : "rim", "map" : ".participation[typeCode=AUT].role" }, { "identity" : "w5", "map" : "who.author" } ] }, { "id" : "AllergyIntolerance.recorder.id", "path" : "AllergyIntolerance.recorder.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.recorder.extension", "path" : "AllergyIntolerance.recorder.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.recorder.reference", "path" : "AllergyIntolerance.recorder.reference", "short" : "Literal reference, Relative, internal or absolute URL", "definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.reference", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "condition" : [ "ele-1", "ref-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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.recorder.identifier", "path" : "AllergyIntolerance.recorder.identifier", "short" : "Logical reference, when literal reference is not known", "definition" : "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "min" : 0, "max" : "0", "base" : { "path" : "Reference.identifier", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Identifier" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity" : "rim", "map" : "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity" : "servd", "map" : "Identifier" }, { "identity" : "rim", "map" : ".identifier" } ] }, { "id" : "AllergyIntolerance.recorder.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.recorder.display", "short" : "Text alternative for the resource", "definition" : "Plain text narrative that identifies the resource in addition to the resource reference.", "comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.asserter", "path" : "AllergyIntolerance.asserter", "short" : "Source of the information about the allergy", "definition" : "The source of the information about the allergy that is recorded.", "comment" : "The recorder takes repsonsibility for the content, but can reference the source from where they got it.", "alias" : [ "Source", "Informant" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.asserter", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "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" }, { "key" : "ref-1", "severity" : "error", "human" : "SHALL have a contained resource if a local reference is provided", "expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity" : "v2", "map" : "IAM-14 (if patient) / IAM-18 (if practitioner)" }, { "identity" : "rim", "map" : ".participation[typeCode=INF].role" }, { "identity" : "w5", "map" : "who.source" } ] }, { "id" : "AllergyIntolerance.asserter.id", "path" : "AllergyIntolerance.asserter.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.asserter.extension", "path" : "AllergyIntolerance.asserter.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.asserter.reference", "path" : "AllergyIntolerance.asserter.reference", "short" : "Literal reference, Relative, internal or absolute URL", "definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.reference", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "condition" : [ "ele-1", "ref-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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.asserter.identifier", "path" : "AllergyIntolerance.asserter.identifier", "short" : "Logical reference, when literal reference is not known", "definition" : "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "min" : 0, "max" : "0", "base" : { "path" : "Reference.identifier", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Identifier" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity" : "rim", "map" : "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity" : "servd", "map" : "Identifier" }, { "identity" : "rim", "map" : ".identifier" } ] }, { "id" : "AllergyIntolerance.asserter.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.asserter.display", "short" : "Text alternative for the resource", "definition" : "Plain text narrative that identifies the resource in addition to the resource reference.", "comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min" : 0, "max" : "1", "base" : { "path" : "Reference.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.lastOccurrence", "path" : "AllergyIntolerance.lastOccurrence", "short" : "Date(/time) of last known occurrence of a reaction", "definition" : "Represents the date and/or time of the last known occurrence of a reaction event.", "comment" : "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.", "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.lastOccurrence", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime" } ] }, { "id" : "AllergyIntolerance.note", "path" : "AllergyIntolerance.note", "short" : "Additional text not captured in other fields", "definition" : "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.", "comment" : "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.", "min" : 0, "max" : "*", "base" : { "path" : "AllergyIntolerance.note", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Annotation" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act" }, { "identity" : "rim", "map" : "subjectOf.observationEvent[code="annotation"].value" } ] }, { "id" : "AllergyIntolerance.note.id", "path" : "AllergyIntolerance.note.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.note.extension", "path" : "AllergyIntolerance.note.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.note.author[x]", "path" : "AllergyIntolerance.note.author[x]", "short" : "Individual responsible for the annotation", "definition" : "The individual responsible for making the annotation.", "comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min" : 0, "max" : "1", "base" : { "path" : "Annotation.author[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code" : "string" } ], "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" }, { "key" : "ref-1", "severity" : "error", "human" : "SHALL have a contained resource if a local reference is provided", "expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.participant[typeCode=AUT].role" } ] }, { "id" : "AllergyIntolerance.note.time", "path" : "AllergyIntolerance.note.time", "short" : "When the annotation was made", "definition" : "Indicates when this particular annotation was made.", "min" : 0, "max" : "1", "base" : { "path" : "Annotation.time", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.effectiveTime" } ] }, { "id" : "AllergyIntolerance.note.text", "path" : "AllergyIntolerance.note.text", "short" : "The annotation - text content", "definition" : "The text of the annotation.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 1, "max" : "1", "base" : { "path" : "Annotation.text", "min" : 1, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.text" } ] }, { "id" : "AllergyIntolerance.reaction", "path" : "AllergyIntolerance.reaction", "short" : "Adverse Reaction Events linked to exposure to substance", "definition" : "Details about each adverse reaction event linked to exposure to the identified substance.", "min" : 0, "max" : "*", "base" : { "path" : "AllergyIntolerance.reaction", "min" : 0, "max" : "*" }, "type" : [ { "code" : "BackboneElement" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]" } ] }, { "id" : "AllergyIntolerance.reaction.id", "path" : "AllergyIntolerance.reaction.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.extension", "path" : "AllergyIntolerance.reaction.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.modifierExtension", "path" : "AllergyIntolerance.reaction.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" } ], "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" }, { "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')])" } ], "isModifier" : true, "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.substance", "path" : "AllergyIntolerance.reaction.substance", "short" : "Specific substance or pharmaceutical product considered to be responsible for event", "definition" : "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.", "comment" : "Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identifed as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.", "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.reaction.substance", "min" : 0, "max" : "1" }, "type" : [ { "code" : "CodeableConcept" } ], "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" } ], "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SubstanceCode" } ], "strength" : "example", "description" : "Codes defining the type of the substance (including pharmaceutical products).", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/substance-code" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "rim", "map" : "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]" } ] }, { "id" : "AllergyIntolerance.reaction.substance.id", "path" : "AllergyIntolerance.reaction.substance.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.substance.extension", "path" : "AllergyIntolerance.reaction.substance.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding", "path" : "AllergyIntolerance.reaction.substance.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 0, "max" : "*", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.id", "path" : "AllergyIntolerance.reaction.substance.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.extension", "path" : "AllergyIntolerance.reaction.substance.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.system", "path" : "AllergyIntolerance.reaction.substance.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.version", "path" : "AllergyIntolerance.reaction.substance.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.code", "path" : "AllergyIntolerance.reaction.substance.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.reaction.substance.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.reaction.substance.coding.userSelected", "path" : "AllergyIntolerance.reaction.substance.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.reaction.substance.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.reaction.substance.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation", "path" : "AllergyIntolerance.reaction.manifestation", "short" : "Clinical symptoms/signs associated with the Event", "definition" : "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.", "comment" : "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.", "alias" : [ "Symptoms", "Signs" ], "min" : 1, "max" : "*", "base" : { "path" : "AllergyIntolerance.reaction.manifestation", "min" : 1, "max" : "*" }, "type" : [ { "code" : "CodeableConcept", "profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" } ], "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" } ], "mustSupport" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Manifestation" } ], "strength" : "preferred", "description" : "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "v2", "map" : "AL1-5" }, { "identity" : "rim", "map" : "code" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.id", "path" : "AllergyIntolerance.reaction.manifestation.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.extension", "path" : "AllergyIntolerance.reaction.manifestation.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding", "path" : "AllergyIntolerance.reaction.manifestation.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 0, "max" : "*", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.id", "path" : "AllergyIntolerance.reaction.manifestation.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.extension", "path" : "AllergyIntolerance.reaction.manifestation.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.system", "path" : "AllergyIntolerance.reaction.manifestation.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.version", "path" : "AllergyIntolerance.reaction.manifestation.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.code", "path" : "AllergyIntolerance.reaction.manifestation.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.reaction.manifestation.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.coding.userSelected", "path" : "AllergyIntolerance.reaction.manifestation.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.reaction.manifestation.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.reaction.manifestation.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.reaction.description", "path" : "AllergyIntolerance.reaction.description", "short" : "Description of the event as a whole", "definition" : "Text description about the reaction as a whole, including details of the manifestation if required.", "comment" : "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.", "alias" : [ "Narrative", "Text" ], "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.reaction.description", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "text" } ] }, { "id" : "AllergyIntolerance.reaction.onset", "path" : "AllergyIntolerance.reaction.onset", "short" : "Date(/time) when manifestations showed", "definition" : "Record of the date and/or time of the onset of the Reaction.", "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.reaction.onset", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "AL1-6" }, { "identity" : "rim", "map" : "effectiveTime.low" } ] }, { "id" : "AllergyIntolerance.reaction.severity", "path" : "AllergyIntolerance.reaction.severity", "short" : "mild | moderate | severe (of event as a whole)", "definition" : "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.", "comment" : "It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.", "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.reaction.severity", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "mustSupport" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceSeverity" } ], "strength" : "required", "description" : "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/reaction-event-severity" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute", "path" : "AllergyIntolerance.reaction.exposureRoute", "short" : "How the subject was exposed to the substance", "definition" : "Identification of the route by which the subject was exposed to the substance.", "comment" : "Coding of the route of exposure with a terminology should be used wherever possible.", "min" : 0, "max" : "1", "base" : { "path" : "AllergyIntolerance.reaction.exposureRoute", "min" : 0, "max" : "1" }, "type" : [ { "code" : "CodeableConcept" } ], "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" } ], "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "RouteOfAdministration" } ], "strength" : "example", "description" : "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/ValueSet/route-codes" } }, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE" }, { "identity" : "rim", "map" : "CD" }, { "identity" : "orim", "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity" : "rim", "map" : "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.id", "path" : "AllergyIntolerance.reaction.exposureRoute.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.extension", "path" : "AllergyIntolerance.reaction.exposureRoute.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding", "path" : "AllergyIntolerance.reaction.exposureRoute.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min" : 0, "max" : "*", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Coding" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.id", "path" : "AllergyIntolerance.reaction.exposureRoute.coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.extension", "path" : "AllergyIntolerance.reaction.exposureRoute.coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.system", "path" : "AllergyIntolerance.reaction.exposureRoute.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.version", "path" : "AllergyIntolerance.reaction.exposureRoute.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.code", "path" : "AllergyIntolerance.reaction.exposureRoute.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.reaction.exposureRoute.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.coding.userSelected", "path" : "AllergyIntolerance.reaction.exposureRoute.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] }, { "id" : "AllergyIntolerance.reaction.exposureRoute.text", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "AllergyIntolerance.reaction.exposureRoute.text", "short" : "Plain text representation of the concept", "definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min" : 0, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code="text/plain"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id" : "AllergyIntolerance.reaction.note", "path" : "AllergyIntolerance.reaction.note", "short" : "Text about event not captured in other fields", "definition" : "Additional text about the adverse reaction event not captured in other fields.", "comment" : "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.", "min" : 0, "max" : "*", "base" : { "path" : "AllergyIntolerance.reaction.note", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Annotation" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act" }, { "identity" : "rim", "map" : "subjectOf.observationEvent[code="annotation"].value" } ] }, { "id" : "AllergyIntolerance.reaction.note.id", "path" : "AllergyIntolerance.reaction.note.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "AllergyIntolerance.reaction.note.extension", "path" : "AllergyIntolerance.reaction.note.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "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.", "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" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "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')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "AllergyIntolerance.reaction.note.author[x]", "path" : "AllergyIntolerance.reaction.note.author[x]", "short" : "Individual responsible for the annotation", "definition" : "The individual responsible for making the annotation.", "comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min" : 0, "max" : "1", "base" : { "path" : "Annotation.author[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code" : "Reference", "targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code" : "string" } ], "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" }, { "key" : "ref-1", "severity" : "error", "human" : "SHALL have a contained resource if a local reference is provided", "expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.participant[typeCode=AUT].role" } ] }, { "id" : "AllergyIntolerance.reaction.note.time", "path" : "AllergyIntolerance.reaction.note.time", "short" : "When the annotation was made", "definition" : "Indicates when this particular annotation was made.", "min" : 0, "max" : "1", "base" : { "path" : "Annotation.time", "min" : 0, "max" : "1" }, "type" : [ { "code" : "dateTime" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.effectiveTime" } ] }, { "id" : "AllergyIntolerance.reaction.note.text", "path" : "AllergyIntolerance.reaction.note.text", "short" : "The annotation - text content", "definition" : "The text of the annotation.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 1, "max" : "1", "base" : { "path" : "Annotation.text", "min" : 1, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.text" } ] } ] }, "differential" : { "element" : [ { "id" : "AllergyIntolerance.clinicalStatus", "path" : "AllergyIntolerance.clinicalStatus", "min" : 1, "mustSupport" : true }, { "id" : "AllergyIntolerance.verificationStatus", "path" : "AllergyIntolerance.verificationStatus", "comment" : "In the scope of the IPS the entered-in-error concept is not allowed.", "mustSupport" : true }, { "id" : "AllergyIntolerance.type", "path" : "AllergyIntolerance.type", "mustSupport" : true }, { "id" : "AllergyIntolerance.criticality", "path" : "AllergyIntolerance.criticality", "mustSupport" : true }, { "id" : "AllergyIntolerance.code", "path" : "AllergyIntolerance.code", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "coding.system" } ], "rules" : "closed" }, "min" : 1, "mustSupport" : true }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy", "path" : "AllergyIntolerance.code", "sliceName" : "absentOrUnknownAllergy", "short" : "Code for absent or unknown allergy or intolerance", "definition" : "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This describes a categorical negated statement (e.g., "No known allergy").", "type" : [ { "code" : "CodeableConcept", "profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" } ], "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCode" } ], "strength" : "required", "description" : "negation/exclusion codes for reporting no known allergies or not available data.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-allergies-uv-ips" } } }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding", "path" : "AllergyIntolerance.code.coding", "min" : 1, "max" : "1" }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.system", "path" : "AllergyIntolerance.code.coding.system", "min" : 1, "fixedUri" : "urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1" }, { "id" : "AllergyIntolerance.code:absentOrUnknownAllergy.coding.code", "path" : "AllergyIntolerance.code.coding.code", "min" : 1 }, { "id" : "AllergyIntolerance.code:default", "path" : "AllergyIntolerance.code", "sliceName" : "default", "definition" : "Code for an allergy or intolerance statement . This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy").", "type" : [ { "code" : "CodeableConcept", "profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" } ], "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "AllergyIntoleranceCode" } ], "strength" : "preferred", "description" : "Type of the substance/product, allergy or intolerance condition.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips" } } }, { "id" : "AllergyIntolerance.patient", "path" : "AllergyIntolerance.patient", "mustSupport" : true }, { "id" : "AllergyIntolerance.patient.identifier", "path" : "AllergyIntolerance.patient.identifier", "max" : "0" }, { "id" : "AllergyIntolerance.onsetDateTime:onsetDateTime", "path" : "AllergyIntolerance.onsetDateTime", "sliceName" : "onsetDateTime", "min" : 1, "type" : [ { "code" : "dateTime" } ], "mustSupport" : true }, { "id" : "AllergyIntolerance.recorder.identifier", "path" : "AllergyIntolerance.recorder.identifier", "max" : "0" }, { "id" : "AllergyIntolerance.asserter.identifier", "path" : "AllergyIntolerance.asserter.identifier", "max" : "0" }, { "id" : "AllergyIntolerance.reaction.manifestation", "path" : "AllergyIntolerance.reaction.manifestation", "type" : [ { "code" : "CodeableConcept", "profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips" } ], "mustSupport" : true, "binding" : { "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Manifestation" } ], "strength" : "preferred", "valueSetReference" : { "reference" : "http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips" } } }, { "id" : "AllergyIntolerance.reaction.severity", "path" : "AllergyIntolerance.reaction.severity", "mustSupport" : true } ] } }