DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

6.1.13.5 StructureDefinition: DAFAllergyList

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/list-daf-dafallergylist

US Realm Allergy list

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

6.1.13.5.1 Formal Views of Profile Content

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

This structure is derived from List.

Summary

Mandatory: 5 elements, Must-Support: 11 elements, Fixed Value: 2 elements, Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from List.

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 1..1ListUS Realm Allergy list
... identifier S0..*Identifier
... code S1..1CodeableConceptFixed code for Allergies.
Fixed Value: {"coding":[{"system":"http://loinc.org","version":"2.48","code":"48765-2"}]}
... subject S0..1patient-daf-dafpatient
... source S1..1pract-daf-dafpract, patient-daf-dafpatient, Device
... date S1..1dateTime
... mode S1..1codeFixed Value: snapshot
... entry S0..*Element
.... flag S0..1CodeableConcept
.... deleted 0..0boolean
.... date S0..1dateTime
.... item S1..1allergyintolerance-daf-dafallergyintolerance
... emptyReason S0..1CodeableConceptBinding: DAFListEmptyReason (extensible)
NameFlagsCard.TypeDescription & Constraintsdoco
.. List I1..1ListUS Realm Allergy list
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-1: A list can only have an emptyReason if it is empty
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... title Σ0..1stringDescriptive name for the list
Example: Dr. Jane's Patients
... code S Σ1..1CodeableConceptFixed code for Allergies.
Binding: ListPurpose (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","version":"2.48","code":"48765-2"}]}
... subject S Σ0..1patient-daf-dafpatientIf all resources have the same subject
... source S Σ1..1pract-daf-dafpract, patient-daf-dafpatient, DeviceWho and/or what defined the list contents
... status ?! Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... date S Σ1..1dateTimeWhen the list was prepared
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: ListOrder (preferred)
... mode ?! SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required)
Fixed Value: snapshot
... note 0..1stringComments about the note
... entry S I0..*ElementEntries in the list
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... flag S0..1CodeableConceptWorkflow information about this item
Binding: ListItemFlag (example)
.... date S0..1dateTimeWhen item added to list
.... item S1..1allergyintolerance-daf-dafallergyintoleranceActual entry
... emptyReason S I0..1CodeableConceptWhy list is empty
Binding: DAFListEmptyReason (extensible)

todo

This structure is derived from List.

Summary

Mandatory: 5 elements, Must-Support: 11 elements, Fixed Value: 2 elements, Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from List.

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 1..1ListUS Realm Allergy list
... identifier S0..*Identifier
... code S1..1CodeableConceptFixed code for Allergies.
Fixed Value: {"coding":[{"system":"http://loinc.org","version":"2.48","code":"48765-2"}]}
... subject S0..1patient-daf-dafpatient
... source S1..1pract-daf-dafpract, patient-daf-dafpatient, Device
... date S1..1dateTime
... mode S1..1codeFixed Value: snapshot
... entry S0..*Element
.... flag S0..1CodeableConcept
.... deleted 0..0boolean
.... date S0..1dateTime
.... item S1..1allergyintolerance-daf-dafallergyintolerance
... emptyReason S0..1CodeableConceptBinding: DAFListEmptyReason (extensible)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I1..1ListUS Realm Allergy list
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-1: A list can only have an emptyReason if it is empty
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... title Σ0..1stringDescriptive name for the list
Example: Dr. Jane's Patients
... code S Σ1..1CodeableConceptFixed code for Allergies.
Binding: ListPurpose (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","version":"2.48","code":"48765-2"}]}
... subject S Σ0..1patient-daf-dafpatientIf all resources have the same subject
... source S Σ1..1pract-daf-dafpract, patient-daf-dafpatient, DeviceWho and/or what defined the list contents
... status ?! Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... date S Σ1..1dateTimeWhen the list was prepared
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: ListOrder (preferred)
... mode ?! SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required)
Fixed Value: snapshot
... note 0..1stringComments about the note
... entry S I0..*ElementEntries in the list
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... flag S0..1CodeableConceptWorkflow information about this item
Binding: ListItemFlag (example)
.... date S0..1dateTimeWhen item added to list
.... item S1..1allergyintolerance-daf-dafallergyintoleranceActual entry
... emptyReason S I0..1CodeableConceptWhy list is empty
Binding: DAFListEmptyReason (extensible)

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

6.1.13.5.2 Terminology Bindings

PathNameConformanceValueSet
List.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
List.codeListPurposeexampleExample Use Codes for List
List.statusListStatusrequiredListStatus
List.orderedByListOrderpreferredList Order Codes
List.modeListModerequiredListMode
List.entry.flagListItemFlagexamplePatient Medicine Change Types
List.emptyReasonDAFListEmptyReasonextensibleList Empty Reasons

6.1.13.5.3 Constraints

IdPathNameDetails
lst-2ListDeleted RuleThe deleted flag can only be used if the mode of the list is "changes"
XPath: (f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))
lst-1ListNo emptyReason if list is not emptyA list can only have an emptyReason if it is empty
XPath: not(exists(f:emptyReason) and exists(f:entry))
.