SDOH Clinical Care
0.0.4C1 - CI Build

SDOH Clinical Care - Local Development build (v0.0.4C1). See the Directory of published versions

StructureDefinition: SDOHCC_List_FoodInsecurity_1

This profile constrains the List Resource for representing a list of patients to be screened.

The official URL for this profile is:

http://hl7.org/fhir/us/sdoh-cc/StructureDefinition/SDOHCC-List-FoodInsecurity-1

Formal Views of Profile Content

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

This structure is derived from List

Summary

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list is a curated collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!ΣI1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title ΣI0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code ΣI0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter I0..1Reference(Encounter)Context in which list created
... date ΣI0..1dateTimeWhen the list was prepared
... source ΣI0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy I0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note I0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag I0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date I0..1dateTimeWhen item added to list
.... item I1..1Reference(Resource)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

This structure is derived from List

Summary

Differential View

This structure is derived from List

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list is a curated collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!ΣI1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title ΣI0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code ΣI0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter I0..1Reference(Encounter)Context in which list created
... date ΣI0..1dateTimeWhen the list was prepared
... source ΣI0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy I0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note I0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag I0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date I0..1dateTimeWhen item added to list
.... item I1..1Reference(Resource)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
List.languagepreferredCommonLanguages
Max Binding: AllLanguages
List.statusrequiredListStatus
List.moderequiredListMode
List.codeexampleExampleUseCodesForList
List.orderedBypreferredListOrderCodes
List.entry.flagexamplePatientMedicineChangeTypes
List.emptyReasonpreferredListEmptyReasons

Constraints

Constraints

IdPathDetailsRequirements
dom-2ListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ListIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5ListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ListA resource should have narrative for robust management
: text.`div`.exists()
lst-1ListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2ListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3ListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()
ele-1List.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.orderedByAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.entry.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.entry.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.entry.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.entry.flagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.deletedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.emptyReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())