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.
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter | 0..1 | Reference(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..1 | Reference(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 | |
identifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
verificationStatus | 1..1 | code | unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatus (required) | |
code | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code 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..* | Extension | Extension 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..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
patient | 1..1 | Reference(CareConnectPatient1) | Who the sensitivity is for | |
onset[x] | S | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified |
assertedDate | 1..1 | dateTime | Date record was believed accurate | |
recorder | 0..1 | Reference(CareConnectPatient1 | CareConnect-Practitioner-1) | Who recorded the sensitivity | |
asserter | 0..1 | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | Source of the information about the allergy | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||
authorString | string | |||
reaction | ||||
substance | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Care Connect Allergy Manifestation (extensible) | |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) | |
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Care Connect Allergy Exposure Route (example) | |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||
authorString | string | |||
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
AllergyIntolerance.code.coding:snomedCT | example | Care Connect Allergy Code |
AllergyIntolerance.reaction.manifestation | extensible | Care Connect Allergy Manifestation |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
AllergyIntolerance.reaction.exposureRoute | example | Care Connect Allergy Exposure Route |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter | 0..1 | Reference(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..1 | Reference(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..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!ΣC | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!ΣC | 1..1 | code | unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatus (required) |
patient | Σ | 1..1 | Reference(CareConnectPatient1) | Who the sensitivity is for |
onset[x] | S | 0..1 | When allergy or intolerance was identified | |
onsetDateTime | dateTime | |||
onsetAge | Age | |||
onsetPeriod | Period | |||
onsetRange | Range | |||
onsetString | string | |||
assertedDate | 1..1 | dateTime | Date record was believed accurate | |
recorder | 0..1 | Reference(CareConnectPatient1 | CareConnect-Practitioner-1) | Who recorded the sensitivity | |
asserter | Σ | 0..1 | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | Source of the information about the allergy |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatus |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus='entered-in-error' or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus!='entered-in-error' or clinicalStatus.empty() | |
dom-1 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If 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-4 | error | AllergyIntolerance | If 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
encounter | 0..1 | Reference(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..1 | Reference(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..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External ids for this item | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
clinicalStatus | ?!ΣC | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance. | ||||
verificationStatus | ?!ΣC | 1..1 | code | unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatus (required) | ||||
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance. | ||||
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
code | Σ | 0..1 | CodeableConcept | Code 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code 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..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patient | Σ | 1..1 | Reference(CareConnectPatient1) | Who the sensitivity is for | ||||
onset[x] | S | 0..1 | When allergy or intolerance was identified | |||||
onsetDateTime | dateTime | |||||||
onsetAge | Age | |||||||
onsetPeriod | Period | |||||||
onsetRange | Range | |||||||
onsetString | string | |||||||
assertedDate | 1..1 | dateTime | Date record was believed accurate | |||||
recorder | 0..1 | Reference(CareConnectPatient1 | CareConnect-Practitioner-1) | Who recorded the sensitivity | |||||
asserter | Σ | 0..1 | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | Source of the information about the allergy | ||||
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
note | 0..* | Annotation | Additional text not captured in other fields | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | 1..1 | string | The annotation - text content | |||||
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
substance | 0..1 | CodeableConcept | Specific 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Care Connect Allergy Manifestation (extensible) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
description | 0..1 | string | Description of the event as a whole | |||||
onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) | |||||
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Care Connect Allergy Exposure Route (example) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
note | 0..* | Annotation | Text about event not captured in other fields | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | 1..1 | string | The annotation - text content | |||||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must 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:
Differential View
This structure is derived from AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter | 0..1 | Reference(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..1 | Reference(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 | |
identifier | ||||
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
verificationStatus | 1..1 | code | unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatus (required) | |
code | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code 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..* | Extension | Extension 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..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
patient | 1..1 | Reference(CareConnectPatient1) | Who the sensitivity is for | |
onset[x] | S | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified |
assertedDate | 1..1 | dateTime | Date record was believed accurate | |
recorder | 0..1 | Reference(CareConnectPatient1 | CareConnect-Practitioner-1) | Who recorded the sensitivity | |
asserter | 0..1 | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | Source of the information about the allergy | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||
authorString | string | |||
reaction | ||||
substance | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Care Connect Allergy Manifestation (extensible) | |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) | |
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Care Connect Allergy Exposure Route (example) | |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:snomedCT | 0..1 | Coding | Code defined by a terminology system | |
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
note | ||||
author[x] | 0..1 | Individual responsible for the annotation | ||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||
authorString | string | |||
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
AllergyIntolerance.code.coding:snomedCT | example | Care Connect Allergy Code |
AllergyIntolerance.reaction.manifestation | extensible | Care Connect Allergy Manifestation |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
AllergyIntolerance.reaction.exposureRoute | example | Care Connect Allergy Exposure Route |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter | 0..1 | Reference(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..1 | Reference(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..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!ΣC | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!ΣC | 1..1 | code | unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatus (required) |
patient | Σ | 1..1 | Reference(CareConnectPatient1) | Who the sensitivity is for |
onset[x] | S | 0..1 | When allergy or intolerance was identified | |
onsetDateTime | dateTime | |||
onsetAge | Age | |||
onsetPeriod | Period | |||
onsetRange | Range | |||
onsetString | string | |||
assertedDate | 1..1 | dateTime | Date record was believed accurate | |
recorder | 0..1 | Reference(CareConnectPatient1 | CareConnect-Practitioner-1) | Who recorded the sensitivity | |
asserter | Σ | 0..1 | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | Source of the information about the allergy |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatus |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus='entered-in-error' or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus!='entered-in-error' or clinicalStatus.empty() | |
dom-1 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If 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-4 | error | AllergyIntolerance | If 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
encounter | 0..1 | Reference(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..1 | Reference(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..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External ids for this item | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
clinicalStatus | ?!ΣC | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance. | ||||
verificationStatus | ?!ΣC | 1..1 | code | unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatus (required) | ||||
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance. | ||||
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
code | Σ | 0..1 | CodeableConcept | Code 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code 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..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patient | Σ | 1..1 | Reference(CareConnectPatient1) | Who the sensitivity is for | ||||
onset[x] | S | 0..1 | When allergy or intolerance was identified | |||||
onsetDateTime | dateTime | |||||||
onsetAge | Age | |||||||
onsetPeriod | Period | |||||||
onsetRange | Range | |||||||
onsetString | string | |||||||
assertedDate | 1..1 | dateTime | Date record was believed accurate | |||||
recorder | 0..1 | Reference(CareConnectPatient1 | CareConnect-Practitioner-1) | Who recorded the sensitivity | |||||
asserter | Σ | 0..1 | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | Source of the information about the allergy | ||||
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
note | 0..* | Annotation | Additional text not captured in other fields | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | 1..1 | string | The annotation - text content | |||||
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
substance | 0..1 | CodeableConcept | Specific 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Care Connect Allergy Manifestation (extensible) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
description | 0..1 | string | Description of the event as a whole | |||||
onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) | |||||
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Care Connect Allergy Exposure Route (example) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
note | 0..* | Annotation | Text about event not captured in other fields | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(RelatedPerson | CareConnectPatient1 | CareConnect-Practitioner-1) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | 1..1 | string | The annotation - text content | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
AllergyIntolerance.language | extensible | Common Languages
| ||||
AllergyIntolerance.identifier.use | required | IdentifierUse | ||||
AllergyIntolerance.identifier.type | extensible | Identifier Type Codes | ||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatus | ||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus | ||||
AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
AllergyIntolerance.code | example | AllergyIntolerance Substance/Product, Condition and Negation Codes | ||||
AllergyIntolerance.code.coding:snomedCT | example | Care Connect Allergy Code | ||||
AllergyIntolerance.reaction.substance | example | Substance Code | ||||
AllergyIntolerance.reaction.manifestation | extensible | Care Connect Allergy Manifestation | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
AllergyIntolerance.reaction.exposureRoute | example | Care Connect Allergy Exposure Route |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must 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:
Other representations of profile: CSV, Excel, Schematron