Requirements
The Requirements resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/Requirements| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/Requirements/[id] |
| Vread | GET | /fhir/R5/Requirements/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Requirements/[id] |
| Patch | PATCH | /fhir/R5/Requirements/[id] |
| Delete | DELETE | /fhir/R5/Requirements/[id] |
| Create | POST | /fhir/R5/Requirements |
| Search | GET | /fhir/R5/Requirements?... |
| History | GET | /fhir/R5/Requirements/[id]/_history |
| Type-history | GET | /fhir/R5/Requirements/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this Requirements, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the Requirements (business identifier) |
version | string | 0..1 | Business version of the Requirements |
versionAlgorithm[x] | string / Coding | 0..1 | How to compare versions |
name | string | 0..1 | Name for this Requirements (computer friendly) |
title | string | 0..1 | Name for this Requirements (human friendly) |
status | code | 1..1 | draft |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher/steward (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the requirements |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for Requirements (if applicable) |
purpose | markdown | 0..1 | Why this Requirements is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
copyrightLabel | string | 0..1 | Copyright holder and year(s) |
derivedFrom | canonical | 0..* | Other set of Requirements this builds on |
reference | url | 0..* | External artifact (rule/document etc. that) created this set of requirements |
actor | canonical | 0..* | Actor for these requirements |
statement | BackboneElement | 0..* | Actual statement as markdown |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
actor | reference | An actor these requirements are for |
context | token | A use context assigned to the activity definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
context-type | token | A type of use context assigned to the activity definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition |
context-type-value | composite | A use context type and value assigned to the activity definition |
date | date | The activity definition publication date |
derived-from | reference | The requirements these are derived from |
description | string | The description of the activity definition |
identifier | token | External identifier for the activity definition |
jurisdiction | token | Intended jurisdiction for the activity definition |
name | string | Computationally friendly name of the activity definition |
publisher | string | Name of the publisher of the activity definition |
status | token | The current status of the activity definition |
title | string | The human-friendly name of the activity definition |
url | uri | The uri that identifies the activity definition |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
Requirements - Maturity: Trial Use 1 (FMM 1).