Current Build

This page is part of the Pharmacist Care Plan FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

This is a pre-release of a future version of the Pharmacist Care Plan FHIR IG (expected to be STU 1). There is no current official version.
For a full list of available versions, see the Directory of published versions .

D.4.1 StructureDefinition: PhCP-Intervention-List

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/phcp/StructureDefinition/PhCP-Intervention-List

This profile builds on List.

This profile was published on Mon Jul 31 10:17:15 AEST 2017 as a draft by Lantana Consulting Group.

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

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*Information summarized from a list of other resources
... id Σ0..1idLogical id of this artifact
... 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: Common Languages (extensible)
... 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 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!Σ1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title Σ0..1stringDescriptive name for the list
Example General': Dr. Jane's Patients
... code Σ0..1CodeableConceptcode
Binding: Example Use Codes for List (example)
Required Pattern: {"coding":[{"system":"http://snomed.info/sct","code":"362956003"}]}
... subject Σ1..1Reference(US Core Patient Profile)If all resources have the same subject
... encounter 0..1Reference(PhCP-Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner), Reference(Patient), Reference(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 I1..*BackboneElementEntries in the list
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: Patient Medicine Change Types (example)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(PhCP-MedicationDispense), Reference(PhCP-CareCoordination), Reference(PhCP-Education-Procedure), Reference(US Core MedicationStatement Profile)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: List Empty Reasons (preferred)

doco Documentation for this format

Differential View

This structure is derived from List

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*Information summarized from a list of other resources
... id Σ0..1idLogical id of this artifact
... 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: Common Languages (extensible)
... 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 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!Σ1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title Σ0..1stringDescriptive name for the list
Example General': Dr. Jane's Patients
... code Σ0..1CodeableConceptcode
Binding: Example Use Codes for List (example)
Required Pattern: {"coding":[{"system":"http://snomed.info/sct","code":"362956003"}]}
... subject Σ1..1Reference(US Core Patient Profile)If all resources have the same subject
... encounter 0..1Reference(PhCP-Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner), Reference(Patient), Reference(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 I1..*BackboneElementEntries in the list
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: Patient Medicine Change Types (example)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(PhCP-MedicationDispense), Reference(PhCP-CareCoordination), Reference(PhCP-Education-Procedure), Reference(US Core MedicationStatement Profile)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: List Empty Reasons (preferred)

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
List.languageCommon LanguagesextensibleCommon Languages
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 ReasonspreferredList Empty Reasons

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ListIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ListIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ListIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
lst-2ListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-1ListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1List.entryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.