International Patient Summary Implementation Guide (Release 0.3.0 STU1 Ballot)

International Patient Summary Implementation Guide, published by Health Level Seven International - Patient Care Work Group. This is not an authorized publication; it is the continuous build for version 0.3.0). This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

SD.34 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.34.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 13:57:18 UTC 2018 as a draft by .

This profile builds on AllergyIntolerance


Summary

Mandatory: 2 elements
Must-Support: 15 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 pattern:$this

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance SI0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*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 ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*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ΣI0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category ΣI0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣI0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code SΣI1..1(Slice Definition)Concept - reference to a terminology or just text
Slice: Unordered, Open by pattern:$this
Binding: IPS Allergy intolerance substance condition (preferred)
.... code:absentOrUnknownAllergy SI0..1CodeableConceptIPSCode for absent or unknown allergy or intolerance
Binding: Absent or Unknown Allergies (required)
... patient SΣI1..1Reference(Patient (IPS))Who the sensitivity is for
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... encounter I0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] I0..1(Slice Definition)When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime SI0..1dateTimeWhen allergy or intolerance was identified
... recordedDate I0..1dateTimeDate first version of the resource instance was recorded
... recorder I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the sensitivity
... asserter SΣI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... lastOccurrence I0..1dateTimeDate(/time) of last known occurrence of a reaction
... note I0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance I0..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 I0..1stringDescription of the event as a whole
.... onset SI0..1dateTimeDate(/time) when manifestations showed
.... severity SI0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute I0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example)
.... note I0..*AnnotationText about event not captured in other fields

doco Documentation for this format

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