SDOH Clinical Care - Local Development build (v0.0.4C3). See the Directory of published versions
This profile constrains the List Resource for representing a patient or 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
This structure is derived from List
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | 0..* | List | A list is a curated collection of resources | |
subject | 0..0 | |||
entry | S | 1..* | BackboneElement | Entries in the list |
item | S | 1..1 | Reference(US Core Patient Profile) | Actual entry |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | A list is a curated collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | I | 0..* | Identifier | Business identifier |
status | ?!ΣI | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
mode | ?!ΣI | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
title | ΣI | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
code | ΣI | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example) |
encounter | I | 0..1 | Reference(Encounter) | Context in which list created |
date | ΣI | 0..1 | dateTime | When the list was prepared |
source | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
orderedBy | I | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred) |
note | I | 0..* | Annotation | Comments about the list |
entry | SI | 1..* | BackboneElement | Entries in the list |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
flag | I | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example) |
deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
date | I | 0..1 | dateTime | When item added to list |
item | SI | 1..1 | Reference(US Core Patient Profile) | Actual entry |
emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred) |
Documentation for this format |
This structure is derived from List
Differential View
This structure is derived from List
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | 0..* | List | A list is a curated collection of resources | |
subject | 0..0 | |||
entry | S | 1..* | BackboneElement | Entries in the list |
item | S | 1..1 | Reference(US Core Patient Profile) | Actual entry |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | A list is a curated collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | I | 0..* | Identifier | Business identifier |
status | ?!ΣI | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
mode | ?!ΣI | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
title | ΣI | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
code | ΣI | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example) |
encounter | I | 0..1 | Reference(Encounter) | Context in which list created |
date | ΣI | 0..1 | dateTime | When the list was prepared |
source | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
orderedBy | I | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred) |
note | I | 0..* | Annotation | Comments about the list |
entry | SI | 1..* | BackboneElement | Entries in the list |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
flag | I | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example) |
deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
date | I | 0..1 | dateTime | When item added to list |
item | SI | 1..1 | Reference(US Core Patient Profile) | Actual entry |
emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred) |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
List.language | preferred | CommonLanguages Max Binding: AllLanguages |
List.status | required | ListStatus |
List.mode | required | ListMode |
List.code | example | ExampleUseCodesForList |
List.orderedBy | preferred | ListOrderCodes |
List.entry.flag | example | PatientMedicineChangeTypes |
List.emptyReason | preferred | ListEmptyReasons |
Id | Path | Details | Requirements |
dom-2 | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | List | If 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-4 | List | If 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-5 | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | List | A resource should have narrative for robust management : text.`div`.exists() | |
lst-1 | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
lst-2 | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
lst-3 | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() | |
ele-1 | List.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | List.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | List.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | List.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | List.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.orderedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | List.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | List.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | List.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | List.entry.flag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.entry.deleted | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.entry.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.entry.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | List.emptyReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |