International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

SD.39 StructureDefinition-allergyintolerance-uv-ips

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.

Conformance resource variables defined here

SD.39.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/allergyintolerance-uv-ips

Published on Wed Feb 14 23:57:18 AEST 2018 as a draft by .

This profile builds on AllergyIntolerance

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element AllergyIntolerance.code.coding is sliced based on the value of value:system (Closed)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required)
... verificationStatus ?!SΣI0..1codeunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required)
... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category Σ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣCodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
.... coding I0..*coding-uv-ipsCode for absent or unknown allergy or intolerance
Binding: Absent or Unknown Allergies (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsA reference to a code defined by a terminology system
Binding: IPS Allergy intolerance substance condition (preferred)
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(Patient)Who the sensitivity is for
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onsetDateTime S1..1dateTimeWhen allergy or intolerance was identified
... recordedDate 0..1dateTimeDate record was first recorded
... recorder 0..1Reference(Practitioner | Patient | RelatedPerson)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction SI0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example)
.... manifestation SI1..*CodeableConcept-uv-ipsClinical symptoms/signs associated with the Event
Binding: Allergy Reaction (preferred)
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron