This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

12.2.12 JSON Schema for Transport

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: No defined compartments

This is a representation of the json schema for Transport, 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/Transport",
  "$ref": "#/definitions/Transport",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Transport": {
      "description": "The Transport resource represents the movement or transportation of individuals and items (such materials and equipment) within a healthcare setting. It encompasses both planned and completed transport events.",
      "properties": {
        "resourceType": {
          "description": "This is a Transport resource",
          "const": "Transport"
        },
        "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"
        },
        "identifier": {
          "description": "Identifier for the transport event that is used to identify it across multiple disparate systems.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "instantiates": {
          "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 Transport.",
          "$ref": "canonical.schema.json#/definitions/canonical"
        },
        "basedOn": {
          "description": "BasedOn refers to a higher-level authorization that triggered the creation of the transport.  It references a \"request\" resource such as a ServiceRequest or Transport, which is distinct from the \"request\" resource the Transport is seeking to fulfill.  This latter resource is referenced by FocusOn.  For example, based on a ServiceRequest (\u003d BasedOn), a transport is created to fulfill a procedureRequest ( \u003d FocusOn ) to transport a specimen to the lab.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "partOf": {
          "description": "A larger event of which this particular event is a component or step.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "status": {
          "description": "A code specifying the state of the transport event.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "statusReason": {
          "description": "An explanation as to why this transport is held, failed, was refused, etc.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "code": {
          "description": "A name or code (or both) briefly describing what the transport 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 resource representing the physical entity being transported.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "subject": {
          "description": "The entity who benefits from the performance of the service specified in the transport (such as patient or subject).",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "The healthcare event  (e.g. a patient and healthcare provider interaction) during which this transport was created.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "completionTime": {
          "description": "Identifies the completion time of the event (the occurrence).",
          "$ref": "#/definitions/dateTime"
        },
        "_completionTime": {
          "description": "Extensions for completionTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "authoredOn": {
          "description": "The date and time this transport 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 transport.",
          "$ref": "#/definitions/dateTime"
        },
        "_lastModified": {
          "description": "Extensions for lastModified",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "performer": {
          "description": "Identifies the entity expected to perform the transport.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "location": {
          "description": "Principal physical location where this transport is 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 Transport.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "note": {
          "description": "Free-text information captured about the transport as it progresses.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        },
        "relevantHistory": {
          "description": "Links to Provenance records for past versions of this Transport that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the transport.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "to": {
          "description": "The target location for the transport event.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "from": {
          "description": "The starting location for the transport event.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "reason": {
          "description": "A resource reference indicating why this transport needs to be performed.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "history": {
          "description": "The transport event prior to this one.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "from",
        "to",
        "resourceType"
      ]
    }
  }
}