Release 4B
This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Orders and Observations 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 Task, which is just a part of the full JSON Schema.
Workflow
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/Task",
"$ref": "#/definitions/Task",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Task": {
"description": "A task to be performed.",
"properties": {
"resourceType": {
"description": "This is a Task resource",
"const": "Task"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "string.schema.json#/definitions/string"
},
"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, and nor can they have their own independent transaction scope.",
"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 manageable, 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 manageable, 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"
},
"identifier": {
"description": "The business identifier for this task.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"instantiatesCanonical": {
"description": "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"instantiatesUri": {
"description": "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.",
"$ref": "#/definitions/uri"
},
"_instantiatesUri": {
"description": "Extensions for instantiatesUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"basedOn": {
"description": "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (\u003d BasedOn), a task is created to fulfill a procedureRequest ( \u003d FocusOn ) to collect a specimen from a patient.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"groupIdentifier": {
"description": "An identifier that links together multiple tasks and other requests that were created in the same context.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"partOf": {
"description": "Task that this particular task is part of.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "The current status of the task.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"statusReason": {
"description": "An explanation as to why this task is held, failed, was refused, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"businessStatus": {
"description": "Contains business-specific nuances of the business state.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"intent": {
"description": "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.",
"$ref": "#/definitions/code"
},
"_intent": {
"description": "Extensions for intent",
"$ref": "Element.schema.json#/definitions/Element"
},
"priority": {
"description": "Indicates how quickly the Task should be addressed with respect to other requests.",
"$ref": "#/definitions/code"
},
"_priority": {
"description": "Extensions for priority",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "A name or code (or both) briefly describing what the task involves.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"description": {
"description": "A free-text description of what is to be performed.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"focus": {
"description": "The request being actioned or the resource being manipulated by this task.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"for": {
"description": "The entity who benefits from the performance of the service specified in the task (e.g., the patient).",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"encounter": {
"description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"executionPeriod": {
"description": "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).",
"$ref": "Period.schema.json#/definitions/Period"
},
"authoredOn": {
"description": "The date and time this task was created.",
"$ref": "#/definitions/dateTime"
},
"_authoredOn": {
"description": "Extensions for authoredOn",
"$ref": "Element.schema.json#/definitions/Element"
},
"lastModified": {
"description": "The date and time of last modification to this task.",
"$ref": "#/definitions/dateTime"
},
"_lastModified": {
"description": "Extensions for lastModified",
"$ref": "Element.schema.json#/definitions/Element"
},
"requester": {
"description": "The creator of the task.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"performerType": {
"description": "The kind of participant that should perform the task.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"owner": {
"description": "Individual organization or Device currently responsible for task execution.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"location": {
"description": "Principal physical location where the this task is performed.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"reasonCode": {
"description": "A description or code indicating why this task needs to be performed.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"reasonReference": {
"description": "A resource reference indicating why this task needs to be performed.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"insurance": {
"description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"note": {
"description": "Free-text information captured about the task as it progresses.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"relevantHistory": {
"description": "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"restriction": {
"description": "If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.",
"$ref": "#/definitions/Task_Restriction"
},
"input": {
"description": "Additional information that may be needed in the execution of the task.",
"items": {
"$ref": "#/definitions/Task_Input"
},
"type": "array"
},
"output": {
"description": "Outputs produced by the Task.",
"items": {
"$ref": "#/definitions/Task_Output"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Task_Restriction": {
"description": "A task to be performed.",
"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 manageable, 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 manageable, 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"
},
"repetitions": {
"description": "Indicates the number of times the requested action should occur.",
"$ref": "#/definitions/positiveInt"
},
"_repetitions": {
"description": "Extensions for repetitions",
"$ref": "Element.schema.json#/definitions/Element"
},
"period": {
"description": "Over what time-period is fulfillment sought.",
"$ref": "Period.schema.json#/definitions/Period"
},
"recipient": {
"description": "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"additionalProperties": false
},
"Task_Input": {
"description": "A task to be performed.",
"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 manageable, 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 manageable, 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"
},
"type": {
"description": "A code or description indicating how the input is intended to be used as part of the task execution.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueBase64Binary": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$",
"type": "string"
},
"_valueBase64Binary": {
"description": "Extensions for valueBase64Binary",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCanonical": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueCanonical": {
"description": "Extensions for valueCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCode": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^[^\\s]+(\\s[^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDate": {
"description": "The value of the input parameter as a basic 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": "The value of the input parameter as a basic 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]+)?(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": "The value of the input parameter as a basic type.",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueId": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_valueId": {
"description": "Extensions for valueId",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInstant": {
"description": "The value of the input parameter as a basic 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]+)?(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": "The value of the input parameter as a basic type.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueMarkdown": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueMarkdown": {
"description": "Extensions for valueMarkdown",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueOid": {
"description": "The value of the input parameter as a basic 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": "The value of the input parameter as a basic type.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_valuePositiveInt": {
"description": "Extensions for valuePositiveInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueString": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueTime": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUnsignedInt": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_valueUnsignedInt": {
"description": "Extensions for valueUnsignedInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUri": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUrl": {
"description": "The value of the input parameter as a basic type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUrl": {
"description": "Extensions for valueUrl",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUuid": {
"description": "The value of the input parameter as a basic 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": "The value of the input parameter as a basic type.",
"$ref": "Address.schema.json#/definitions/Address"
},
"valueAge": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Age.schema.json#/definitions/Age"
},
"valueAnnotation": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"valueAttachment": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"valueCodeableConcept": {
"description": "The value of the input parameter as a basic type.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueCoding": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueContactPoint": {
"description": "The value of the input parameter as a basic type.",
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"valueCount": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Count.schema.json#/definitions/Count"
},
"valueDistance": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Distance.schema.json#/definitions/Distance"
},
"valueDuration": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"valueHumanName": {
"description": "The value of the input parameter as a basic type.",
"$ref": "HumanName.schema.json#/definitions/HumanName"
},
"valueIdentifier": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"valueMoney": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Money.schema.json#/definitions/Money"
},
"valuePeriod": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Period.schema.json#/definitions/Period"
},
"valueQuantity": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueRange": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueRatio": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"valueReference": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"valueSampledData": {
"description": "The value of the input parameter as a basic type.",
"$ref": "SampledData.schema.json#/definitions/SampledData"
},
"valueSignature": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Signature.schema.json#/definitions/Signature"
},
"valueTiming": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"valueContactDetail": {
"description": "The value of the input parameter as a basic type.",
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"valueContributor": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Contributor.schema.json#/definitions/Contributor"
},
"valueDataRequirement": {
"description": "The value of the input parameter as a basic type.",
"$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
},
"valueExpression": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"valueParameterDefinition": {
"description": "The value of the input parameter as a basic type.",
"$ref": "ParameterDefinition.schema.json#/definitions/ParameterDefinition"
},
"valueRelatedArtifact": {
"description": "The value of the input parameter as a basic type.",
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"valueTriggerDefinition": {
"description": "The value of the input parameter as a basic type.",
"$ref": "TriggerDefinition.schema.json#/definitions/TriggerDefinition"
},
"valueUsageContext": {
"description": "The value of the input parameter as a basic type.",
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"valueDosage": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Dosage.schema.json#/definitions/Dosage"
},
"valueMeta": {
"description": "The value of the input parameter as a basic type.",
"$ref": "Meta.schema.json#/definitions/Meta"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
"Task_Output": {
"description": "A task to be performed.",
"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 manageable, 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 manageable, 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"
},
"type": {
"description": "The name of the Output parameter.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueBase64Binary": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$",
"type": "string"
},
"_valueBase64Binary": {
"description": "Extensions for valueBase64Binary",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCanonical": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueCanonical": {
"description": "Extensions for valueCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCode": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^[^\\s]+(\\s[^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDate": {
"description": "The value of the Output parameter as a basic 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": "The value of the Output parameter as a basic 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]+)?(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": "The value of the Output parameter as a basic type.",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueId": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_valueId": {
"description": "Extensions for valueId",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInstant": {
"description": "The value of the Output parameter as a basic 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]+)?(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": "The value of the Output parameter as a basic type.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueMarkdown": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueMarkdown": {
"description": "Extensions for valueMarkdown",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueOid": {
"description": "The value of the Output parameter as a basic 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": "The value of the Output parameter as a basic type.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_valuePositiveInt": {
"description": "Extensions for valuePositiveInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueString": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueTime": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUnsignedInt": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_valueUnsignedInt": {
"description": "Extensions for valueUnsignedInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUri": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUrl": {
"description": "The value of the Output parameter as a basic type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUrl": {
"description": "Extensions for valueUrl",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUuid": {
"description": "The value of the Output parameter as a basic 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": "The value of the Output parameter as a basic type.",
"$ref": "Address.schema.json#/definitions/Address"
},
"valueAge": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Age.schema.json#/definitions/Age"
},
"valueAnnotation": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"valueAttachment": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"valueCodeableConcept": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueCoding": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueContactPoint": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"valueCount": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Count.schema.json#/definitions/Count"
},
"valueDistance": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Distance.schema.json#/definitions/Distance"
},
"valueDuration": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"valueHumanName": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "HumanName.schema.json#/definitions/HumanName"
},
"valueIdentifier": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"valueMoney": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Money.schema.json#/definitions/Money"
},
"valuePeriod": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Period.schema.json#/definitions/Period"
},
"valueQuantity": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueRange": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueRatio": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"valueReference": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"valueSampledData": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "SampledData.schema.json#/definitions/SampledData"
},
"valueSignature": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Signature.schema.json#/definitions/Signature"
},
"valueTiming": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"valueContactDetail": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"valueContributor": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Contributor.schema.json#/definitions/Contributor"
},
"valueDataRequirement": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
},
"valueExpression": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"valueParameterDefinition": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "ParameterDefinition.schema.json#/definitions/ParameterDefinition"
},
"valueRelatedArtifact": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"valueTriggerDefinition": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "TriggerDefinition.schema.json#/definitions/TriggerDefinition"
},
"valueUsageContext": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"valueDosage": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Dosage.schema.json#/definitions/Dosage"
},
"valueMeta": {
"description": "The value of the Output parameter as a basic type.",
"$ref": "Meta.schema.json#/definitions/Meta"
}
},
"additionalProperties": false,
"required": [
"type"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR Release 4B (v4.3.0) hl7.fhir.r4b.core#4.3.0 generated on Sat, May 28, 2022 12:57+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change