This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

5.12.13 JSON Schema for Requirements

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: No defined compartments

This is a representation of the json schema for Requirements, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/Requirements",
  "$ref": "#/definitions/Requirements",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Requirements": {
      "description": "A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals.",
      "properties": {
        "resourceType": {
          "description": "This is a Requirements resource",
          "const": "Requirements"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "url": {
          "description": "An absolute URI that is used to identify this Requirements when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers.",
          "$ref": "#/definitions/uri"
        },
        "_url": {
          "description": "Extensions for url",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "identifier": {
          "description": "A formal identifier that is used to identify this Requirements when it is represented in other formats, or referenced in a specification, model, design or an instance.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "version": {
          "description": "The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
          "$ref": "#/definitions/string"
        },
        "_version": {
          "description": "Extensions for version",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "versionAlgorithmString": {
          "description": "Indicates the mechanism used to compare versions to determine which is more current.",
          "pattern": "^^[\\s\\S]+$$",
          "type": "string"
        },
        "_versionAlgorithmString": {
          "description": "Extensions for versionAlgorithmString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "versionAlgorithmCoding": {
          "description": "Indicates the mechanism used to compare versions to determine which is more current.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "name": {
          "description": "A natural language name identifying the Requirements. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "title": {
          "description": "A short, descriptive, user-friendly title for the Requirements.",
          "$ref": "#/definitions/string"
        },
        "_title": {
          "description": "Extensions for title",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "status": {
          "description": "The status of this Requirements. Enables tracking the life-cycle of the content.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "experimental": {
          "description": "A Boolean value to indicate that this Requirements is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
          "$ref": "#/definitions/boolean"
        },
        "_experimental": {
          "description": "Extensions for experimental",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "date": {
          "description": "The date  (and optionally time) when the Requirements was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Requirements changes.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "publisher": {
          "description": "The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements.",
          "$ref": "#/definitions/string"
        },
        "_publisher": {
          "description": "Extensions for publisher",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "contact": {
          "description": "Contact details to assist a user in finding and communicating with the publisher.",
          "items": {
            "$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
          },
          "type": "array"
        },
        "description": {
          "description": "A free text natural language description of the requirements.",
          "$ref": "#/definitions/markdown"
        },
        "_description": {
          "description": "Extensions for description",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "useContext": {
          "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Requirements instances.",
          "items": {
            "$ref": "UsageContext.schema.json#/definitions/UsageContext"
          },
          "type": "array"
        },
        "jurisdiction": {
          "description": "A legal or geographic region in which the Requirements is intended to be used.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "purpose": {
          "description": "Explanation of why this Requirements is needed and why it has been designed as it has.",
          "$ref": "#/definitions/markdown"
        },
        "_purpose": {
          "description": "Extensions for purpose",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "copyright": {
          "description": "A copyright statement relating to the Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements.",
          "$ref": "#/definitions/markdown"
        },
        "_copyright": {
          "description": "Extensions for copyright",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "copyrightLabel": {
          "description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
          "$ref": "#/definitions/string"
        },
        "_copyrightLabel": {
          "description": "Extensions for copyrightLabel",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "derivedFrom": {
          "description": "Another set of Requirements that this set of Requirements builds on and updates.",
          "items": {
            "$ref": "canonical.schema.json#/definitions/canonical"
          },
          "type": "array"
        },
        "reference": {
          "description": "A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.",
          "items": {
            "$ref": "#/definitions/url"
          },
          "type": "array"
        },
        "_reference": {
          "description": "Extensions for reference",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "actor": {
          "description": "An actor these requirements are in regard to.",
          "items": {
            "$ref": "canonical.schema.json#/definitions/canonical"
          },
          "type": "array"
        },
        "statement": {
          "description": "The actual statement of requirement, in markdown format.",
          "items": {
            "$ref": "#/definitions/Requirements_Statement"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "Requirements_Statement": {
      "description": "A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "key": {
          "description": "Key that identifies this statement (unique within this resource).",
          "$ref": "#/definitions/id"
        },
        "_key": {
          "description": "Extensions for key",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "label": {
          "description": "A short human usable label for this statement.",
          "$ref": "#/definitions/string"
        },
        "_label": {
          "description": "Extensions for label",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "conformance": {
          "description": "A short human usable label for this statement.",
          "items": {
            "$ref": "#/definitions/code"
          },
          "type": "array"
        },
        "_conformance": {
          "description": "Extensions for conformance",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "conditionality": {
          "description": "This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like \u0027if x then y\u0027. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.",
          "$ref": "#/definitions/boolean"
        },
        "_conditionality": {
          "description": "Extensions for conditionality",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "requirement": {
          "description": "The actual requirement for human consumption.",
          "$ref": "#/definitions/markdown"
        },
        "_requirement": {
          "description": "Extensions for requirement",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "derivedFrom": {
          "description": "Another statement on one of the requirements that this requirement clarifies or restricts.",
          "$ref": "#/definitions/string"
        },
        "_derivedFrom": {
          "description": "Extensions for derivedFrom",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "parent": {
          "description": "A larger requirement that this requirement helps to refine and enable.",
          "$ref": "#/definitions/string"
        },
        "_parent": {
          "description": "Extensions for parent",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "satisfiedBy": {
          "description": "A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.",
          "items": {
            "$ref": "#/definitions/url"
          },
          "type": "array"
        },
        "_satisfiedBy": {
          "description": "Extensions for satisfiedBy",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "reference": {
          "description": "A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.",
          "items": {
            "$ref": "#/definitions/url"
          },
          "type": "array"
        },
        "_reference": {
          "description": "Extensions for reference",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "source": {
          "description": "Who asked for this statement to be a requirement. By default, it\u0027s assumed that the publisher knows who it is if it matters.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}