2nd DSTU Draft For Comment

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

Profile: DAFList

The official URL for this profile is: 

http://hl7.org/fhir/Profile/list-daf-daflist

. Defines constraints and extensions on the List resource for use in querying and retrieving lists of DAF FHIR resources : U.S. Data Access Framework (DAF) List Profile

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

Summary

Required/Prohibited Elements

  • The element List is required
  • The element List.code is required
  • The element List.source is required
  • The element List.date is required
  • The element List.mode is required
  • The element List.entry.deleted is prohibited
  • The element List.entry.item is required

Formal Views of Profile Content

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I1..1Information summarized from a list of other resources.
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
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained S0..*U.S.html, U.S.html, U.S. Data Access Framework (DAF) Condition (a.k.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.htmlContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... code S1..1CodeableConceptWhat the purpose of this list is
Binding: ListPurpose (example, extensible)
... subject S0..1patient-daf-dafpatientIf all resources have the same subject
... source 1..1Practitioner, Patient, DeviceWho and/or what defined the list contents
... date S1..1dateTimeWhen the list was prepared
... ordered M0..1booleanWhether items in the list have a meaningful order
... mode M S1..1codeworking | snapshot | changes
Binding: ListMode (required, not extensible)
Example: For DAF it will always be 'snapshot'
... entry S I0..1ElementEntries in the list
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... flag 0..1CodeableConceptWorkflow information about this item
Binding: ListItemFlag (example, extensible)
.... date 0..1dateTimeWhen item added to list
.... item S1..1patient-daf-dafpatient, allergyintolerance-daf-dafallergyintolerance, condition-daf-dafcondition, encounter-daf-dafencounter, observation-daf-vitalsigns-dafvitalsigns, procedure-daf-dafprocedure, medicationstatement-daf-dafmedicationstatement, medicationadministration-daf-dafmedicationadministration, immunization-daf-dafimmunization, diagnosticreport-daf-dafdiagnosticreport, diagnosticorder-daf-dafdiagnosticorder, observation-daf-smokingstatus-dafsmokingstatusActual entry
... emptyReason S I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReason (preferred, extensible)

XML Template

JSON Template

todo

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I1..1Information summarized from a list of other resources.
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
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained S0..*U.S.html, U.S.html, U.S. Data Access Framework (DAF) Condition (a.k.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.html, U.S.htmlContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... code S1..1CodeableConceptWhat the purpose of this list is
Binding: ListPurpose (example, extensible)
... subject S0..1patient-daf-dafpatientIf all resources have the same subject
... source 1..1Practitioner, Patient, DeviceWho and/or what defined the list contents
... date S1..1dateTimeWhen the list was prepared
... ordered M0..1booleanWhether items in the list have a meaningful order
... mode M S1..1codeworking | snapshot | changes
Binding: ListMode (required, not extensible)
Example: For DAF it will always be 'snapshot'
... entry S I0..1ElementEntries in the list
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... flag 0..1CodeableConceptWorkflow information about this item
Binding: ListItemFlag (example, extensible)
.... date 0..1dateTimeWhen item added to list
.... item S1..1patient-daf-dafpatient, allergyintolerance-daf-dafallergyintolerance, condition-daf-dafcondition, encounter-daf-dafencounter, observation-daf-vitalsigns-dafvitalsigns, procedure-daf-dafprocedure, medicationstatement-daf-dafmedicationstatement, medicationadministration-daf-dafmedicationadministration, immunization-daf-dafimmunization, diagnosticreport-daf-dafdiagnosticreport, diagnosticorder-daf-dafdiagnosticorder, observation-daf-smokingstatus-dafsmokingstatusActual entry
... emptyReason S I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReason (preferred, extensible)

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
List.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
List.codeListPurposeexample (extensible)Example Use Codes for List
List.modeListModerequiredListMode
List.entry.flagListItemFlagexample (extensible)Patient Medicine Change Types
List.emptyReasonListEmptyReasonpreferred (extensible)List Empty Reasons

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))
.