JohnMoehrke PHR FHIR API
0.5.2 - ci-build United States of America flag

JohnMoehrke PHR FHIR API, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.5.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/phr/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR Allergy and Intolerance

Official URL: http://johnmoehrke.github.io/phr/StructureDefinition/JFM.PHR.allergyIntolerance Version: 0.5.2
Standards status: Trial-use Maturity Level: 4 Computable Name: JFMallergyIntolerance

A profile on the AllergyIntolerance resource for MHV PHR exposing Allergies using FHIR API.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:observedHistoric S 0..1 code Allergy Observed vs Historic
URL: http://johnmoehrke.github.io/phr/StructureDefinition/allergyObservedHistoric
Binding: Allergy Observed vs Historic ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier External ids for this item
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:recordIdentifier Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: official
..... system ΣC 0..1 uri `http://va.gov/systems/` | {intoleranceCondition.recordIdentifier.namespaceId}
ele-1: All FHIR elements must have a @value or children
HDRid-startswithoid: ID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {intoleranceCondition.recordIdentifier.identity}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:TOid Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `AllergyTO` | `.` | {intoleranceCondition.recordIdentifier.identity}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
ele-1: All FHIR elements must have a @value or children
... verificationStatus ?!SΣC 0..1 CodeableConcept May indicate entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
ele-1: All FHIR elements must have a @value or children
... category SΣ 0..* code food | medication | environment | biologic
Binding: Subset of allergy intolerance category (required)
ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(US Core Patient Profile) Who the sensitivity is for
ele-1: All FHIR elements must have a @value or children
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
ele-1: All FHIR elements must have a @value or children
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) {c} Who recorded the sensitivity
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:visn 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Organization) {c} Value of extension
ele-1: All FHIR elements must have a @value or children
.... display SΣ 0..1 string Text alternative for the resource
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Additional text not captured in other fields
ele-1: All FHIR elements must have a @value or children
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... manifestation S 1..1 CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
ele-1: All FHIR elements must have a @value or children
..... text Σ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AllergyIntolerance.identifier:recordIdentifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyCategoryVS
http://johnmoehrke.github.io/phr/ValueSet/AllergyCategoryVS
from this IG
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
HDRid-startswithoiderrorAllergyIntolerance.identifier:recordIdentifier.systemID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
: value.startsWith('http://va.gov/systems/')
TOid-startswithoiderrorAllergyIntolerance.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* USCoreAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observedHistoric S 0..1 code Allergy Observed vs Historic
URL: http://johnmoehrke.github.io/phr/StructureDefinition/allergyObservedHistoric
Binding: Allergy Observed vs Historic ValueSet (preferred)
... Slices for identifier 1..* Identifier External ids for this item
Slice: Unordered, Open by value:use
.... identifier:recordIdentifier 0..1 Identifier External ids for this item
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system C 0..1 uri `http://va.gov/systems/` | {intoleranceCondition.recordIdentifier.namespaceId}
HDRid-startswithoid: ID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
..... value 0..1 string {intoleranceCondition.recordIdentifier.identity}
.... identifier:TOid 0..1 Identifier External ids for this item
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `AllergyTO` | `.` | {intoleranceCondition.recordIdentifier.identity}
... clinicalStatus 0..1 CodeableConcept active | inactive | resolved
... verificationStatus 0..1 CodeableConcept May indicate entered-in-error
... category S 0..* code food | medication | environment | biologic
Binding: Subset of allergy intolerance category (required)
... criticality 0..0
... code
.... coding 0..0
.... text 1..1 string Plain text representation of the concept
... patient 1..1 Reference(US Core Patient Profile) Who the sensitivity is for
... encounter 0..0
... onset[x] 0..0
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) {c} Who recorded the sensitivity
.... Slices for extension Content/Rules for all slices
..... extension:visn 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... value[x] 1..1 Reference(Organization) {c} Value of extension
.... display S 0..1 string Text alternative for the resource
... asserter 0..0
... lastOccurrence 0..0
... note S 0..* Annotation Additional text not captured in other fields
.... author[x] 0..0
.... time S 0..1 dateTime When the annotation was made
.... text S 1..1 markdown The annotation - text content (as markdown)
... reaction
.... substance 0..0
.... manifestation 1..1 CodeableConcept Clinical symptoms/signs associated with the Event
..... coding
...... system 0..1 uri Identity of the terminology system
...... code 0..1 code Symbol in syntax defined by the system
..... text 0..1 string Plain text representation of the concept
.... description 0..0
.... onset 0..0
.... severity 0..0
.... exposureRoute 0..0
.... note 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.categoryrequiredAllergyCategoryVS
http://johnmoehrke.github.io/phr/ValueSet/AllergyCategoryVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
HDRid-startswithoiderrorAllergyIntolerance.identifier:recordIdentifier.systemID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
: value.startsWith('http://va.gov/systems/')
TOid-startswithoiderrorAllergyIntolerance.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
.... extension:observedHistoric S 0..1 code Allergy Observed vs Historic
URL: http://johnmoehrke.github.io/phr/StructureDefinition/allergyObservedHistoric
Binding: Allergy Observed vs Historic ValueSet (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier External ids for this item
Slice: Unordered, Open by value:use
.... identifier:recordIdentifier Σ 0..1 Identifier External ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... 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 ΣC 0..1 uri `http://va.gov/systems/` | {intoleranceCondition.recordIdentifier.namespaceId}
HDRid-startswithoid: ID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {intoleranceCondition.recordIdentifier.identity}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TOid Σ 0..1 Identifier External ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... 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 ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `AllergyTO` | `.` | {intoleranceCondition.recordIdentifier.identity}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣC 0..1 CodeableConcept May indicate entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (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 SΣ 0..* code food | medication | environment | biologic
Binding: Subset of allergy intolerance category (required)
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text Σ 1..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(US Core Patient Profile) Who the sensitivity is for
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) {c} Who recorded the sensitivity
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:visn 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Organization) {c} Value of extension
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... note S 0..* Annotation Additional text not captured in other fields
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... time SΣ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..1 CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AllergyIntolerance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier:recordIdentifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:recordIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
from the FHIR Standard
AllergyIntolerance.typerequiredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyCategoryVS
http://johnmoehrke.github.io/phr/ValueSet/AllergyCategoryVS
from this IG
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.recorder.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
HDRid-startswithoiderrorAllergyIntolerance.identifier:recordIdentifier.systemID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
: value.startsWith('http://va.gov/systems/')
TOid-startswithoiderrorAllergyIntolerance.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreAllergyIntolerance

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 13 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.identifier

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:observedHistoric S 0..1 code Allergy Observed vs Historic
URL: http://johnmoehrke.github.io/phr/StructureDefinition/allergyObservedHistoric
Binding: Allergy Observed vs Historic ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier External ids for this item
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:recordIdentifier Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: official
..... system ΣC 0..1 uri `http://va.gov/systems/` | {intoleranceCondition.recordIdentifier.namespaceId}
ele-1: All FHIR elements must have a @value or children
HDRid-startswithoid: ID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {intoleranceCondition.recordIdentifier.identity}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:TOid Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `AllergyTO` | `.` | {intoleranceCondition.recordIdentifier.identity}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
ele-1: All FHIR elements must have a @value or children
... verificationStatus ?!SΣC 0..1 CodeableConcept May indicate entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
ele-1: All FHIR elements must have a @value or children
... category SΣ 0..* code food | medication | environment | biologic
Binding: Subset of allergy intolerance category (required)
ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(US Core Patient Profile) Who the sensitivity is for
ele-1: All FHIR elements must have a @value or children
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
ele-1: All FHIR elements must have a @value or children
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) {c} Who recorded the sensitivity
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:visn 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Organization) {c} Value of extension
ele-1: All FHIR elements must have a @value or children
.... display SΣ 0..1 string Text alternative for the resource
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Additional text not captured in other fields
ele-1: All FHIR elements must have a @value or children
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... manifestation S 1..1 CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
ele-1: All FHIR elements must have a @value or children
..... text Σ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AllergyIntolerance.identifier:recordIdentifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyCategoryVS
http://johnmoehrke.github.io/phr/ValueSet/AllergyCategoryVS
from this IG
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
HDRid-startswithoiderrorAllergyIntolerance.identifier:recordIdentifier.systemID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
: value.startsWith('http://va.gov/systems/')
TOid-startswithoiderrorAllergyIntolerance.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Differential View

This structure is derived from USCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* USCoreAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observedHistoric S 0..1 code Allergy Observed vs Historic
URL: http://johnmoehrke.github.io/phr/StructureDefinition/allergyObservedHistoric
Binding: Allergy Observed vs Historic ValueSet (preferred)
... Slices for identifier 1..* Identifier External ids for this item
Slice: Unordered, Open by value:use
.... identifier:recordIdentifier 0..1 Identifier External ids for this item
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system C 0..1 uri `http://va.gov/systems/` | {intoleranceCondition.recordIdentifier.namespaceId}
HDRid-startswithoid: ID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
..... value 0..1 string {intoleranceCondition.recordIdentifier.identity}
.... identifier:TOid 0..1 Identifier External ids for this item
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `AllergyTO` | `.` | {intoleranceCondition.recordIdentifier.identity}
... clinicalStatus 0..1 CodeableConcept active | inactive | resolved
... verificationStatus 0..1 CodeableConcept May indicate entered-in-error
... category S 0..* code food | medication | environment | biologic
Binding: Subset of allergy intolerance category (required)
... criticality 0..0
... code
.... coding 0..0
.... text 1..1 string Plain text representation of the concept
... patient 1..1 Reference(US Core Patient Profile) Who the sensitivity is for
... encounter 0..0
... onset[x] 0..0
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) {c} Who recorded the sensitivity
.... Slices for extension Content/Rules for all slices
..... extension:visn 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... value[x] 1..1 Reference(Organization) {c} Value of extension
.... display S 0..1 string Text alternative for the resource
... asserter 0..0
... lastOccurrence 0..0
... note S 0..* Annotation Additional text not captured in other fields
.... author[x] 0..0
.... time S 0..1 dateTime When the annotation was made
.... text S 1..1 markdown The annotation - text content (as markdown)
... reaction
.... substance 0..0
.... manifestation 1..1 CodeableConcept Clinical symptoms/signs associated with the Event
..... coding
...... system 0..1 uri Identity of the terminology system
...... code 0..1 code Symbol in syntax defined by the system
..... text 0..1 string Plain text representation of the concept
.... description 0..0
.... onset 0..0
.... severity 0..0
.... exposureRoute 0..0
.... note 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.categoryrequiredAllergyCategoryVS
http://johnmoehrke.github.io/phr/ValueSet/AllergyCategoryVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
HDRid-startswithoiderrorAllergyIntolerance.identifier:recordIdentifier.systemID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
: value.startsWith('http://va.gov/systems/')
TOid-startswithoiderrorAllergyIntolerance.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
.... extension:observedHistoric S 0..1 code Allergy Observed vs Historic
URL: http://johnmoehrke.github.io/phr/StructureDefinition/allergyObservedHistoric
Binding: Allergy Observed vs Historic ValueSet (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier External ids for this item
Slice: Unordered, Open by value:use
.... identifier:recordIdentifier Σ 0..1 Identifier External ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... 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 ΣC 0..1 uri `http://va.gov/systems/` | {intoleranceCondition.recordIdentifier.namespaceId}
HDRid-startswithoid: ID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {intoleranceCondition.recordIdentifier.identity}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TOid Σ 0..1 Identifier External ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... 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 ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `AllergyTO` | `.` | {intoleranceCondition.recordIdentifier.identity}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣC 0..1 CodeableConcept May indicate entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (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 SΣ 0..* code food | medication | environment | biologic
Binding: Subset of allergy intolerance category (required)
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text Σ 1..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(US Core Patient Profile) Who the sensitivity is for
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) {c} Who recorded the sensitivity
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:visn 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Organization) {c} Value of extension
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... note S 0..* Annotation Additional text not captured in other fields
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... time SΣ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..1 CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AllergyIntolerance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier:recordIdentifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:recordIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
from the FHIR Standard
AllergyIntolerance.typerequiredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyCategoryVS
http://johnmoehrke.github.io/phr/ValueSet/AllergyCategoryVS
from this IG
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.recorder.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
HDRid-startswithoiderrorAllergyIntolerance.identifier:recordIdentifier.systemID system must start with http://va.gov/systems/ The next would be the {idSourceTable}
: value.startsWith('http://va.gov/systems/')
TOid-startswithoiderrorAllergyIntolerance.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreAllergyIntolerance

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 13 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.identifier

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron