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

Resource Profile: FHIR Analysis Model for EFSS : Screening Set

Official URL: http://hl7.org/fhir/us/StructureDefinition/ScreeningSet Version: 0.1.0
Draft as of 2024-03-07 Computable Name: ScreeningSet

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:

  • This Resource is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. ScreeningSet 0..*DomainResourceFHIR Analysis Model for EFSS : Screening Set
... identifier Σ0..*Identifieridentifier
... serviceCategory Σ0..*CodeableConceptgeneral classificaiton of the services
... service Σ0..*CodeableConceptone or more specific services needed
... membership 0..*membershipMembership

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ScreeningSet 0..*DomainResourceFHIR Analysis Model for EFSS : Screening Set
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*Identifieridentifier
... service Σ0..*CodeableConceptone or more specific services needed
... status Σ1..1codestatus
... membership 0..*membershipMembership

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorScreeningSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorScreeningSetIf 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-4errorScreeningSetIf 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-5errorScreeningSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceScreeningSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ScreeningSet 0..*DomainResourceFHIR Analysis Model for EFSS : Screening Set
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*Identifieridentifier
... serviceCategory Σ0..*CodeableConceptgeneral classificaiton of the services
... service Σ0..*CodeableConceptone or more specific services needed
... status Σ1..1codestatus
... membership 0..*membershipMembership

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ScreeningSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorScreeningSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorScreeningSetIf 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-4errorScreeningSetIf 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-5errorScreeningSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceScreeningSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element (1 nested mandatory element)

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. ScreeningSet 0..*DomainResourceFHIR Analysis Model for EFSS : Screening Set
... identifier Σ0..*Identifieridentifier
... serviceCategory Σ0..*CodeableConceptgeneral classificaiton of the services
... service Σ0..*CodeableConceptone or more specific services needed
... membership 0..*membershipMembership

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ScreeningSet 0..*DomainResourceFHIR Analysis Model for EFSS : Screening Set
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*Identifieridentifier
... service Σ0..*CodeableConceptone or more specific services needed
... status Σ1..1codestatus
... membership 0..*membershipMembership

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorScreeningSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorScreeningSetIf 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-4errorScreeningSetIf 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-5errorScreeningSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceScreeningSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ScreeningSet 0..*DomainResourceFHIR Analysis Model for EFSS : Screening Set
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*Identifieridentifier
... serviceCategory Σ0..*CodeableConceptgeneral classificaiton of the services
... service Σ0..*CodeableConceptone or more specific services needed
... status Σ1..1codestatus
... membership 0..*membershipMembership

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ScreeningSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorScreeningSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorScreeningSetIf 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-4errorScreeningSetIf 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-5errorScreeningSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceScreeningSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element (1 nested mandatory element)

 

Other representations of profile: CSV, Excel, Schematron