Criteria Requirements Library Profile¶
| Canonical | ../StructureDefinition/nexus-criteria-requirements |
|---|---|
| Status | draft · 1.26.0 |
| Base | Library (constraint) |
| Source | FSH · 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 / Snapshot
The full effective definition: base Library with this profile's constraints applied.
| 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 |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation i Invariants: ele-1 |
|
| contained | 0..* | Resource | Contained, inline Resources i | |
| 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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| url | S | 1..1 | uri | Canonical URL of this manifest, minted per criterion i Invariants: ele-1 |
| identifier | 0..* | Identifier | Additional identifier for the library 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 |
| title | 0..1 | string | Name for this library (human friendly) i Invariants: ele-1 |
|
| subtitle | 0..1 | string | Subordinate title of the library Invariants: ele-1 |
|
| status | S ?! | 1..1 | code | Always active -- a manifest exists only for a criterion that compiled iFixed: activeBinding: publication-status ( required)Invariants: ele-1 |
| experimental | 0..1 | boolean | For testing purposes, not real usage i Invariants: ele-1 |
|
| type | S | 1..1 | CodeableConcept | Always module-definition -- this Library declares requirements, it does not carry content iPattern: {"coding":[{"code":"module-definition","system":"http://terminology.hl7.org/CodeSystem/library-type"}]}Binding: library-type ( extensible)Invariants: ele-1 |
| subject[x] | 0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on Binding: subject-type ( extensible)Invariants: ele-1 |
|
| date | 0..1 | dateTime | Date last changed i Invariants: ele-1 |
|
| publisher | 0..1 | string | Name of the publisher (organization or individual) i Invariants: ele-1 |
|
| contact | 0..* | ContactDetail | Contact details for the publisher i Invariants: ele-1 |
|
| description | 0..1 | markdown | Natural language description of the library i Invariants: ele-1 |
|
| useContext | 0..* | UsageContext | The context that the content is intended to support i Invariants: ele-1 |
|
| jurisdiction | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) i Binding: jurisdiction ( extensible)Invariants: ele-1 |
|
| purpose | 0..1 | markdown | Why this library is defined i Invariants: ele-1 |
|
| usage | 0..1 | string | Describes the clinical usage of the library Invariants: ele-1 |
|
| copyright | 0..1 | markdown | Use and/or publishing restrictions Invariants: ele-1 |
|
| approvalDate | 0..1 | date | When the library was approved by publisher i Invariants: ele-1 |
|
| lastReviewDate | 0..1 | date | When the library was last reviewed i Invariants: ele-1 |
|
| effectivePeriod | 0..1 | Period | When the library is expected to be used i Invariants: ele-1 |
|
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: definition-topic ( example)Invariants: ele-1 |
|
| author | 0..* | ContactDetail | Who authored the content Invariants: ele-1 |
|
| editor | 0..* | ContactDetail | Who edited the content Invariants: ele-1 |
|
| reviewer | 0..* | ContactDetail | Who reviewed the content Invariants: ele-1 |
|
| endorser | 0..* | ContactDetail | Who endorsed the content Invariants: ele-1 |
|
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. i Invariants: ele-1 |
|
| parameter | 0..* | ParameterDefinition | Parameters defined by the library Invariants: ele-1 |
|
| dataRequirement | S | 1..* | DataRequirement | The resource types the logic retrieves, with their profiles and filters i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| type | 1..1 | code | The type of the required data Binding: all-types ( required)Invariants: ele-1 |
|
| profile | 0..* | canonical | The profile of the required data Invariants: ele-1 |
|
| subject[x] | 0..1 | CodeableConcept, Reference(Group) | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device i Binding: subject-type ( extensible)Invariants: ele-1 |
|
| mustSupport | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module Invariants: ele-1 |
|
| codeFilter | 0..* | Element | What codes are expected Invariants: drq-1, ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| path | S | 1..1 | string | The element the codes apply to -- always present on a generated manifest i Invariants: ele-1 |
| searchParam | 0..1 | string | A coded (token) parameter to search on Invariants: ele-1 |
|
| valueSet | 0..1 | canonical | Valueset for the filter Invariants: ele-1 |
|
| code | 0..* | Coding | What code is expected Invariants: ele-1 |
|
| dateFilter | 0..* | Element | What dates/date ranges are expected Invariants: drq-2, ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| path | 0..1 | string | A date-valued attribute to filter on i Invariants: ele-1 |
|
| searchParam | 0..1 | string | A date valued parameter to search on Invariants: ele-1 |
|
| value[x] | 0..1 | dateTime, Period, Duration | The value of the filter, as a Period, DateTime, or Duration value Invariants: ele-1 |
|
| limit | 0..1 | positiveInt | Number of results i Invariants: ele-1 |
|
| sort | 0..* | Element | Order of the results i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-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 |
|
| content | 0..* | Attachment | Contents of the library, either embedded or referenced Invariants: ele-1 |