Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.

Resource Profile: CareConnectAllergyIntolerance1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-AllergyIntolerance-1 Version: 0.1.0
Draft as of 2018-11-05 Computable Name: CareConnect-AllergyIntolerance-1

Copyright/Legal: Copyright © 2016 HL7 UK

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

HL7® FHIR® standard Copyright © 2011+ HL7

The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at

https://www.hl7.org/fhir/license.html

This AllergyIntolerance Resource records Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter 0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... allergyEnd 0..1(Complex)Supports the date and reason that the allergy was no longer valid
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AllergyIntoleranceEnd-1
... identifier
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... verificationStatus 1..1codeunconfirmed | confirmed
Binding: AllergyIntoleranceVerificationStatus (required)
... code
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1CodingCode defined by a terminology system
Binding: Care Connect Allergy Code (example): A code from the SNOMED Clinical Terminology UK or a code from the v3 Code System NullFlavor specifying why a valid value is not present.

...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... patient 1..1Reference(CareConnectPatient1)Who the sensitivity is for
... onset[x] S0..1dateTime, Age, Period, Range, stringWhen allergy or intolerance was identified
... assertedDate 1..1dateTimeDate record was believed accurate
... recorder 0..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1)Who recorded the sensitivity
... asserter 0..1Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)Source of the information about the allergy
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
..... authorStringstring
... reaction
.... substance
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingCode defined by a terminology system
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Care Connect Allergy Manifestation (extensible)
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingCode defined by a terminology system
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: Care Connect Allergy Exposure Route (example)
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingCode defined by a terminology system
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
.... note
..... author[x] 0..1Individual responsible for the annotation
...... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
...... authorStringstring

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
AllergyIntolerance.code.coding:snomedCTexampleCare Connect Allergy Code
AllergyIntolerance.reaction.manifestationextensibleCare Connect Allergy Manifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleCare Connect Allergy Exposure Route
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter 0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... evidence 0..1Reference(DiagnosticReport)A reference to results of investigations that confirmed the certainty of the diagnosis
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Evidence-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... clinicalStatus ?!ΣC0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC1..1codeunconfirmed | confirmed
Binding: AllergyIntoleranceVerificationStatus (required)
... patient Σ1..1Reference(CareConnectPatient1)Who the sensitivity is for
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... assertedDate 1..1dateTimeDate record was believed accurate
... recorder 0..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1)Who recorded the sensitivity
... asserter Σ0..1Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)Source of the information about the allergy

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatus
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
: verificationStatus='entered-in-error' or clinicalStatus.exists()
ait-2errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus!='entered-in-error' or clinicalStatus.empty()
dom-1errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter 0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... allergyEnd 0..1(Complex)Supports the date and reason that the allergy was no longer valid
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AllergyIntoleranceEnd-1
... evidence 0..1Reference(DiagnosticReport)A reference to results of investigations that confirmed the certainty of the diagnosis
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Evidence-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... clinicalStatus ?!ΣC0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC1..1codeunconfirmed | confirmed
Binding: AllergyIntoleranceVerificationStatus (required)
... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category Σ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance.


... criticality Σ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ0..1CodeableConceptCode that identifies the allergy or intolerance
Binding: AllergyIntolerance Substance/Product, Condition and Negation Codes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Allergy Code (example): A code from the SNOMED Clinical Terminology UK or a code from the v3 Code System NullFlavor specifying why a valid value is not present.


...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(CareConnectPatient1)Who the sensitivity is for
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... assertedDate 1..1dateTimeDate record was believed accurate
... recorder 0..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1)Who recorded the sensitivity
... asserter Σ0..1Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... reaction 0..*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
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).

..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Care Connect Allergy Manifestation (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: Care Connect Allergy Exposure Route (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... note 0..*AnnotationText about event not captured in other fields
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] Σ0..1Individual responsible for the annotation
...... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
...... authorStringstring
..... time Σ0..1dateTimeWhen the annotation was made
..... text 1..1stringThe annotation - text content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier.userequiredIdentifierUse
AllergyIntolerance.identifier.typeextensibleIdentifier Type Codes
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatus
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeexampleAllergyIntolerance Substance/Product, Condition and Negation Codes
AllergyIntolerance.code.coding:snomedCTexampleCare Connect Allergy Code
AllergyIntolerance.reaction.substanceexampleSubstance Code
AllergyIntolerance.reaction.manifestationextensibleCare Connect Allergy Manifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleCare Connect Allergy Exposure Route

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 1 element (14 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 3 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.coding is sliced based on the value of value:system
  • The element AllergyIntolerance.reaction.substance.coding is sliced based on the value of value:system
  • The element AllergyIntolerance.reaction.manifestation.coding is sliced based on the value of value:system
  • The element AllergyIntolerance.reaction.exposureRoute.coding is sliced based on the value of value:system

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter 0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... allergyEnd 0..1(Complex)Supports the date and reason that the allergy was no longer valid
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AllergyIntoleranceEnd-1
... identifier
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... verificationStatus 1..1codeunconfirmed | confirmed
Binding: AllergyIntoleranceVerificationStatus (required)
... code
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1CodingCode defined by a terminology system
Binding: Care Connect Allergy Code (example): A code from the SNOMED Clinical Terminology UK or a code from the v3 Code System NullFlavor specifying why a valid value is not present.

...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... patient 1..1Reference(CareConnectPatient1)Who the sensitivity is for
... onset[x] S0..1dateTime, Age, Period, Range, stringWhen allergy or intolerance was identified
... assertedDate 1..1dateTimeDate record was believed accurate
... recorder 0..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1)Who recorded the sensitivity
... asserter 0..1Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)Source of the information about the allergy
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
..... authorStringstring
... reaction
.... substance
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingCode defined by a terminology system
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Care Connect Allergy Manifestation (extensible)
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingCode defined by a terminology system
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: Care Connect Allergy Exposure Route (example)
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingCode defined by a terminology system
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
.... note
..... author[x] 0..1Individual responsible for the annotation
...... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
...... authorStringstring

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
AllergyIntolerance.code.coding:snomedCTexampleCare Connect Allergy Code
AllergyIntolerance.reaction.manifestationextensibleCare Connect Allergy Manifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleCare Connect Allergy Exposure Route

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter 0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... evidence 0..1Reference(DiagnosticReport)A reference to results of investigations that confirmed the certainty of the diagnosis
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Evidence-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... clinicalStatus ?!ΣC0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC1..1codeunconfirmed | confirmed
Binding: AllergyIntoleranceVerificationStatus (required)
... patient Σ1..1Reference(CareConnectPatient1)Who the sensitivity is for
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... assertedDate 1..1dateTimeDate record was believed accurate
... recorder 0..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1)Who recorded the sensitivity
... asserter Σ0..1Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)Source of the information about the allergy

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatus
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
: verificationStatus='entered-in-error' or clinicalStatus.exists()
ait-2errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus!='entered-in-error' or clinicalStatus.empty()
dom-1errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter 0..1Reference(Encounter)Associated Encounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... allergyEnd 0..1(Complex)Supports the date and reason that the allergy was no longer valid
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AllergyIntoleranceEnd-1
... evidence 0..1Reference(DiagnosticReport)A reference to results of investigations that confirmed the certainty of the diagnosis
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Evidence-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... clinicalStatus ?!ΣC0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC1..1codeunconfirmed | confirmed
Binding: AllergyIntoleranceVerificationStatus (required)
... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category Σ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance.


... criticality Σ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ0..1CodeableConceptCode that identifies the allergy or intolerance
Binding: AllergyIntolerance Substance/Product, Condition and Negation Codes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Allergy Code (example): A code from the SNOMED Clinical Terminology UK or a code from the v3 Code System NullFlavor specifying why a valid value is not present.


...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(CareConnectPatient1)Who the sensitivity is for
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... assertedDate 1..1dateTimeDate record was believed accurate
... recorder 0..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1)Who recorded the sensitivity
... asserter Σ0..1Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... reaction 0..*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
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).

..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Care Connect Allergy Manifestation (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: Care Connect Allergy Exposure Route (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... note 0..*AnnotationText about event not captured in other fields
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] Σ0..1Individual responsible for the annotation
...... authorReferenceReference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1)
...... authorStringstring
..... time Σ0..1dateTimeWhen the annotation was made
..... text 1..1stringThe annotation - text content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier.userequiredIdentifierUse
AllergyIntolerance.identifier.typeextensibleIdentifier Type Codes
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatus
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeexampleAllergyIntolerance Substance/Product, Condition and Negation Codes
AllergyIntolerance.code.coding:snomedCTexampleCare Connect Allergy Code
AllergyIntolerance.reaction.substanceexampleSubstance Code
AllergyIntolerance.reaction.manifestationextensibleCare Connect Allergy Manifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleCare Connect Allergy Exposure Route

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 1 element (14 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 3 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.coding is sliced based on the value of value:system
  • The element AllergyIntolerance.reaction.substance.coding is sliced based on the value of value:system
  • The element AllergyIntolerance.reaction.manifestation.coding is sliced based on the value of value:system
  • The element AllergyIntolerance.reaction.exposureRoute.coding is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron