Skip to content

Criteria Requirements Library Profile

Canonical../StructureDefinition/nexus-criteria-requirements
Statusdraft · 1.26.0
BaseLibrary (constraint)
SourceFSH · JSON

The data-requirements manifest generated for a compiled clinical criterion: a FHIR R4 Library with type = module-definition, declaring the resource types the logic retrieves, the profiles they must satisfy, the code and value-set filters applied, and the elements read. Derived from the compiled logic rather than authored beside it, so it cannot drift from the criteria it describes. A deployment artifact verified when a consuming host starts, not an API surface an application reaches.

Elements / Key elements

The working view: must-support, required, modifier and sliced elements from the effective (snapshot) definition.

Element Flags Card. Type Description & Constraints
Library 0..* Criteria data requirements (module-definition Library)
Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, lib-0
implicitRules ?! 0..1 uri A set of rules under which this content was created i
Invariants: ele-1
extension 1..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
extension:criteriaRelativeDate S 1..1 Extension(Criteria Relative Date) Whether membership can change through the passage of time alone -- always present i
Invariants: ele-1, ext-1
extension:criteriaElementsRead S 0..* Extension(Criteria Elements Read) One element path per repetition, bounding what a projection must materialise i
Invariants: ele-1, ext-1
url S 1..1 uri Canonical URL of this manifest, minted per criterion i
Invariants: ele-1
version S 1..1 string The compiled library's own version i
Invariants: ele-1
name S 1..1 string The compiled library's own identifier, machine-readable i
Invariants: ele-1
status S ?! 1..1 code Always active -- a manifest exists only for a criterion that compiled i
Fixed: active
Binding: publication-status (required)
Invariants: ele-1
type S 1..1 CodeableConcept Always module-definition -- this Library declares requirements, it does not carry content i
Pattern: {"coding":[{"code":"module-definition","system":"http://terminology.hl7.org/CodeSystem/library-type"}]}
Binding: library-type (extensible)
Invariants: ele-1
dataRequirement S 1..* DataRequirement The resource types the logic retrieves, with their profiles and filters i
Invariants: ele-1
type 1..1 code The type of the required data
Binding: all-types (required)
Invariants: ele-1
codeFilter 0..* Element What codes are expected
Invariants: drq-1, ele-1
path S 1..1 string The element the codes apply to -- always present on a generated manifest i
Invariants: ele-1
sort 0..* Element Order of the results i
Invariants: ele-1
path 1..1 string The name of the attribute to perform the sort
Invariants: ele-1
direction 1..1 code ascending | descending
Binding: sort-direction (required)
Invariants: ele-1