2.11.12 JSON Schema for Parameters

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is a representation of the json schema for Parameters, 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/Parameters",
  "$ref": "#/definitions/Parameters",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Parameters": {
      "description": "This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment).  It is not persisted or allowed to be referenced by other resources.",
      "properties": {
        "resourceType": {
          "description": "This is a Parameters resource",
          "const": "Parameters"
        },
        "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"
        },
        "parameter": {
          "description": "A parameter passed to or received from the operation.",
          "items": {
            "$ref": "#/definitions/Parameters_Parameter"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "Parameters_Parameter": {
      "description": "This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment).  It is not persisted or allowed to be referenced by other resources.",
      "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"
        },
        "name": {
          "description": "The name of the parameter (reference to the operation definition).",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueBase64Binary": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}\u003d\u003d|[A-Za-z0-9+/]{3}\u003d)?$",
          "type": "string"
        },
        "_valueBase64Binary": {
          "description": "Extensions for valueBase64Binary",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueBoolean": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^true|false$",
          "type": "boolean"
        },
        "_valueBoolean": {
          "description": "Extensions for valueBoolean",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueCanonical": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_valueCanonical": {
          "description": "Extensions for valueCanonical",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueCode": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[^\\s]+( [^\\s]+)*$",
          "type": "string"
        },
        "_valueCode": {
          "description": "Extensions for valueCode",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueDate": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
          "type": "string"
        },
        "_valueDate": {
          "description": "Extensions for valueDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueDateTime": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
          "type": "string"
        },
        "_valueDateTime": {
          "description": "Extensions for valueDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueDecimal": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
          "type": "number"
        },
        "_valueDecimal": {
          "description": "Extensions for valueDecimal",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueId": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
          "type": "string"
        },
        "_valueId": {
          "description": "Extensions for valueId",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueInstant": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
          "type": "string"
        },
        "_valueInstant": {
          "description": "Extensions for valueInstant",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueInteger": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[0]|[-+]?[1-9][0-9]*$",
          "type": "number"
        },
        "_valueInteger": {
          "description": "Extensions for valueInteger",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueInteger64": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[0]|[-+]?[1-9][0-9]*$",
          "type": "string"
        },
        "_valueInteger64": {
          "description": "Extensions for valueInteger64",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueMarkdown": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^\\s*(\\S|\\s)*$",
          "type": "string"
        },
        "_valueMarkdown": {
          "description": "Extensions for valueMarkdown",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueOid": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
          "type": "string"
        },
        "_valueOid": {
          "description": "Extensions for valueOid",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valuePositiveInt": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[1-9][0-9]*$",
          "type": "number"
        },
        "_valuePositiveInt": {
          "description": "Extensions for valuePositiveInt",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueString": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_valueString": {
          "description": "Extensions for valueString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueTime": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
          "type": "string"
        },
        "_valueTime": {
          "description": "Extensions for valueTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueUnsignedInt": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^[0]|([1-9][0-9]*)$",
          "type": "number"
        },
        "_valueUnsignedInt": {
          "description": "Extensions for valueUnsignedInt",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueUri": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_valueUri": {
          "description": "Extensions for valueUri",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueUrl": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^\\S*$",
          "type": "string"
        },
        "_valueUrl": {
          "description": "Extensions for valueUrl",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueUuid": {
          "description": "Conveys the content if the parameter is a data type.",
          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
          "type": "string"
        },
        "_valueUuid": {
          "description": "Extensions for valueUuid",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueAddress": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Address.schema.json#/definitions/Address"
        },
        "valueAge": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Age.schema.json#/definitions/Age"
        },
        "valueAnnotation": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Annotation.schema.json#/definitions/Annotation"
        },
        "valueAttachment": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Attachment.schema.json#/definitions/Attachment"
        },
        "valueCodeableConcept": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueCodeableReference": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "valueCoding": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "valueContactPoint": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
        },
        "valueCount": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Count.schema.json#/definitions/Count"
        },
        "valueDistance": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Distance.schema.json#/definitions/Distance"
        },
        "valueDuration": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Duration.schema.json#/definitions/Duration"
        },
        "valueHumanName": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "HumanName.schema.json#/definitions/HumanName"
        },
        "valueIdentifier": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "valueMoney": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "valuePeriod": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "valueQuantity": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "valueRange": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "valueRatio": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Ratio.schema.json#/definitions/Ratio"
        },
        "valueRatioRange": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "RatioRange.schema.json#/definitions/RatioRange"
        },
        "valueReference": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "valueSampledData": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "SampledData.schema.json#/definitions/SampledData"
        },
        "valueSignature": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Signature.schema.json#/definitions/Signature"
        },
        "valueTiming": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Timing.schema.json#/definitions/Timing"
        },
        "valueContactDetail": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
        },
        "valueDataRequirement": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
        },
        "valueExpression": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Expression.schema.json#/definitions/Expression"
        },
        "valueParameterDefinition": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "ParameterDefinition.schema.json#/definitions/ParameterDefinition"
        },
        "valueRelatedArtifact": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
        },
        "valueTriggerDefinition": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "TriggerDefinition.schema.json#/definitions/TriggerDefinition"
        },
        "valueUsageContext": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "UsageContext.schema.json#/definitions/UsageContext"
        },
        "valueAvailability": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Availability.schema.json#/definitions/Availability"
        },
        "valueExtendedContactDetail": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "ExtendedContactDetail.schema.json#/definitions/ExtendedContactDetail"
        },
        "valueDosage": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Dosage.schema.json#/definitions/Dosage"
        },
        "valueMeta": {
          "description": "Conveys the content if the parameter is a data type.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "resource": {
          "description": "Conveys the content if the parameter is a whole resource.",
          "$ref": "ResourceList.schema.json#/definitions/ResourceList"
        },
        "part": {
          "description": "A named part of a multi-part parameter.",
          "items": {
            "$ref": "#/definitions/Parameters_Parameter"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}