Enhancing FHIR for Social Services
0.1.0 - ci-build
Enhancing FHIR for Social Services, published by SDOH. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/efss/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/StructureDefinition/FHIRScreeningSet | Version: 0.1.0 | |||
| Draft as of 2024-03-07 | Computable Name: FHIRScreeningSet | |||
Screening Set is a composition of individuals in need of service(s). The focus of the Screening Set is provide an effecient construct for identifying and illustraing the individuals in the composition. The Screen Set itself is meant to be transaction and temporal in nature. The Screen Set would be active while the steps taken to acquire the services have been completed. Screenig Set should be viewed as the trigger for acquisition process for the required services but not utilized for the acquisition workflow operations
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Group | Group of multiple entities | |
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership |
![]() ![]() | 0..0 | |||
![]() ![]() | 0..0 | |||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. |
![]() ![]() | ΣC | 1..1 | boolean | Descriptive or actual |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | |
| Group.characteristic.code | example | ||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" | ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership | ||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | Σ | 0..* | Identifier | Unique id | ||||
![]() ![]() | Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
![]() ![]() | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
![]() ![]() | ΣC | 1..1 | boolean | Descriptive or actual | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
![]() ![]() | Σ | 0..1 | string | Label for Group | ||||
![]() ![]() | Σ | 0..1 | unsignedInt | Number of members | ||||
![]() ![]() | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
This structure is derived from Group
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Group | Group of multiple entities | |
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership |
![]() ![]() | 0..0 | |||
![]() ![]() | 0..0 | |||
Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. |
![]() ![]() | ΣC | 1..1 | boolean | Descriptive or actual |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | |
| Group.characteristic.code | example | ||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" | ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership | ||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | Σ | 0..* | Identifier | Unique id | ||||
![]() ![]() | Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
![]() ![]() | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
![]() ![]() | ΣC | 1..1 | boolean | Descriptive or actual | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
![]() ![]() | Σ | 0..1 | string | Label for Group | ||||
![]() ![]() | Σ | 0..1 | unsignedInt | Number of members | ||||
![]() ![]() | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
This structure is derived from Group
Other representations of profile: CSV, Excel, Schematron