International Patient Summary Implementation Guide (Release 0.3.0 STU1 Ballot)

This page is part of the International Patient Summary Implementation Guide (v0.3.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. 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.37 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.

SD.37.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 08:57:18 EST 2018 as a draft by .

This profile builds on AllergyIntolerance

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance SI0..*Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ0..*canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... abatement-dateTime-uv-ips SI0..1dateTimeAbatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: AllergyIntoleranceVerificationStatusCodes (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Σ(Slice Definition)Concept - reference to a terminology or just text
Slice: Unordered, Open by value:coding.system
Binding: IPS Allergy intolerance substance condition (preferred)
.... absentOrUnknownAllergy SI0..1CodeableConceptIPSCode for absent or unknown allergy or intolerance
Binding: Absent or Unknown Allergies (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SI1..1CodingIPSA reference to a code defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips
...... version SΣ0..1stringVersion of the system - if relevant
...... code SΣ0..1codeSymbol in syntax defined by the system
...... display SΣ0..1stringRepresentation defined by the system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... translation SI0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... value 0..1stringPrimitive value for string
Max Length: 1048576
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(Patient (IPS))Who the sensitivity is for
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] (Slice Definition)When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder 0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the sensitivity
... asserter SΣ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example)
.... manifestation SI1..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Allergy Reaction (preferred)
.... description 0..1stringDescription of the event as a whole
.... onset S0..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