STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.22.2 StructureDefinition: DAF-EncounterList

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-encounterlist

US Realm Encounter list

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.22.2.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: 4 elements (+1 nested mandatory element)
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 I0..*ListUS Realm Encounter 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: IETF BCP-47 (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
... status ?! ∑1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?! S∑1..1codeworking | snapshot | changes
Binding: ListMode (required)
Fixed Value: snapshot
... title ∑0..1stringDescriptive name for the list
Example: Dr. Jane's Patients
... code S ∑1..1CodeableConceptWhat the purpose of this list is
Binding: Example Use Codes for List (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"46240-8"}]}
... subject S ∑0..1Reference(DAF-Patient)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date S ∑1..1dateTimeWhen the list was prepared
... source S ∑1..1Reference(DAF-Pract | DAF-Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: List Order Codes (preferred)
... note 0..*AnnotationComments about the list
... entry S I0..*BackboneElementEntries in the list
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... flag S0..1CodeableConceptStatus/Workflow information about this item
Binding: Patient Medicine Change Types (example)
.... date S0..1dateTimeWhen item added to list
.... item S1..1Reference(DAF-Encounter)Actual entry
... emptyReason S I0..1CodeableConceptWhy list is empty
Binding: List Empty Reasons (extensible)

doco Documentation for this format

todo

This structure is derived from List.

Summary

Mandatory: 4 elements (+1 nested mandatory element)
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.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListUS Realm Encounter 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: IETF BCP-47 (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
... status ?! ∑1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?! S∑1..1codeworking | snapshot | changes
Binding: ListMode (required)
Fixed Value: snapshot
... title ∑0..1stringDescriptive name for the list
Example: Dr. Jane's Patients
... code S ∑1..1CodeableConceptWhat the purpose of this list is
Binding: Example Use Codes for List (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"46240-8"}]}
... subject S ∑0..1Reference(DAF-Patient)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date S ∑1..1dateTimeWhen the list was prepared
... source S ∑1..1Reference(DAF-Pract | DAF-Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: List Order Codes (preferred)
... note 0..*AnnotationComments about the list
... entry S I0..*BackboneElementEntries in the list
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... flag S0..1CodeableConceptStatus/Workflow information about this item
Binding: Patient Medicine Change Types (example)
.... date S0..1dateTimeWhen item added to list
.... item S1..1Reference(DAF-Encounter)Actual entry
... emptyReason S I0..1CodeableConceptWhy list is empty
Binding: List Empty Reasons (extensible)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.22.2.2 Terminology Bindings

PathNameConformanceValueSet
List.language?extrequiredhttp://tools.ietf.org/html/bcp47
List.statusListStatusrequiredListStatus
List.modeListModerequiredListMode
List.codeExample Use Codes for ListexampleExample Use Codes for List
List.orderedByList Order CodespreferredList Order Codes
List.entry.flagPatient Medicine Change TypesexamplePatient Medicine Change Types
List.emptyReasonList Empty ReasonsextensibleList Empty Reasons

D.22.2.3 Constraints

IdPathDetailsRequirements
lst-2ListThe 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:deleted))
lst-1ListA list can only have an emptyReason if it is empty
XPath: not(exists(f:emptyReason) and exists(f:entry))
.