Primary Care Implementation Guide

AU Primary Care Implementation Guide - Local Development build (vnull). See the Directory of published versions

1.0 StructureDefinition-au-primarycareallergyintolerance

AU Primary Care Allergy Intolerance Profile [FMM Level 0]

This profile defines an allergy intolerance structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

Examples thanks to Brett Esler - Oridashi .. not yet checked for conformance to this IG

​Oridashi Sample Allergy Intolerance 1

​Oridashi Sample Allergy Intolerance 2

Examples thanks to Jim Steel - CSIRO .. not yet checked for conformance to this IG

​Sample Allergy Intolerance: Unconfirmed peanut allergy

​Sample Allergy Intolerance: eosinophilic oesphagitis triggered by wheat and dairy

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

https://aehrc.com/fhir/StructureDefinition/AUPrimaryCareAllergyIntolerance

This profile defines an allergy intolerance structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

This profile builds on AUBaseAllergyIntolerance.

This profile was published on Wed Nov 06 14:07:15 AEST 2019 as a draft by null.

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

This profile contains the following variations from AU Base Allergy Intolerance:

  1. verificationStatus mustSupport
    • ValueSet binding http://hl7.org/fhir/ValueSet/allergyintolerance-verification added
  2. criticality mustSupport
  3. code mustSupport
  4. patient (Reference: AUPrimaryCarePatient)
  5. assertedDate mustSupport
  6. reaction.substance.coding:snomedSubstance slice mustSupport
  7. reaction.manifestation.coding:snomedManifestation slice mustSupport
    • ValueSet binding http://aehrc.com/valueset/reaction-manifestation added
  8. reaction.note mustSupport
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*An allergy or intolerance statement in an Australian primary care practice-to-practice record transfer context.
... 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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal ids for this item
... clinicalStatus ?!ΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type Σ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 ΣI0..1CodeableConceptCode that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred)
... patient ΣI1..1Reference(AU Primary Care Patient)Who the sensitivity is for
... encounter I0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] I0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... recordedDate SI0..1dateTimeDate first version of the resource instance was recorded
... recorder I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the sensitivity
... asserter Σ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 I0..*BackboneElementReaction details
.... 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 SI1..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding:snomedSubstance SΣI0..*CodingCode defined by a terminology system
..... text ΣI0..1stringPlain text representation of the concept
.... manifestation SI1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding:snomedManifestation SΣI0..*Coding​Code defined by a terminology system
Binding: Reaction manifestation ValueSet (preferred)
..... text ΣI0..1stringPlain text representation of the concept
.... description I0..1stringDescription of the event as a whole
.... onset I0..1dateTimeDate(/time) when manifestations showed
.... severity I0..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
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] ΣI0..1Individual responsible for the annotation
...... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
...... authorStringstring
..... time ΣI0..1dateTimeWhen the annotation was made
..... text SΣI1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

This profile contains the following variations from AU Base Allergy Intolerance:

  1. verificationStatus mustSupport
    • ValueSet binding http://hl7.org/fhir/ValueSet/allergyintolerance-verification added
  2. criticality mustSupport
  3. code mustSupport
  4. patient (Reference: AUPrimaryCarePatient)
  5. assertedDate mustSupport
  6. reaction.substance.coding:snomedSubstance slice mustSupport
  7. reaction.manifestation.coding:snomedManifestation slice mustSupport
    • ValueSet binding http://aehrc.com/valueset/reaction-manifestation added
  8. reaction.note mustSupport

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*An allergy or intolerance statement in an Australian primary care practice-to-practice record transfer context.
... 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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal ids for this item
... clinicalStatus ?!ΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type Σ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 ΣI0..1CodeableConceptCode that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred)
... patient ΣI1..1Reference(AU Primary Care Patient)Who the sensitivity is for
... encounter I0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] I0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... recordedDate SI0..1dateTimeDate first version of the resource instance was recorded
... recorder I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the sensitivity
... asserter Σ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 I0..*BackboneElementReaction details
.... 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 SI1..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding:snomedSubstance SΣI0..*CodingCode defined by a terminology system
..... text ΣI0..1stringPlain text representation of the concept
.... manifestation SI1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding:snomedManifestation SΣI0..*Coding​Code defined by a terminology system
Binding: Reaction manifestation ValueSet (preferred)
..... text ΣI0..1stringPlain text representation of the concept
.... description I0..1stringDescription of the event as a whole
.... onset I0..1dateTimeDate(/time) when manifestations showed
.... severity I0..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
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] ΣI0..1Individual responsible for the annotation
...... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
...... authorStringstring
..... time ΣI0..1dateTimeWhen the annotation was made
..... text SΣI1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

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

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-primarycareallergyintolerance

none defined