Workflow
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
(v3.3.0:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
Ballot
2).
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
|
Work
Group
|
Maturity Level : N/A |
|
Compartments : Patient , Practitioner |
Raw
XML
(
canonical
form
+
also
see
XML
Format
Specification
)
profile
<?xml version="1.0" encoding="UTF-8"?>
Identifies a profile structure or implementation Guide that applies to the datatype this
element refers to. If any profiles are specified, then the content must conform to at
least one of them. The URL can be a local reference - to a contained StructureDefinition,
or a reference to another StructureDefinition or Implementation Guide by a canonical URL.
When an implementation guide is specified, the type SHALL conform to at least one profile
defined in the implementation guide.
Identifies a profile structure or implementation Guide that applies to the datatype this
element refers to. If any profiles are specified, then the content must conform to at
least one of them. The URL can be a local reference - to a contained StructureDefinition,
or a reference to another StructureDefinition or Implementation Guide by a canonical URL.
When an implementation guide is specified, the type SHALL conform to at least one profile
defined in the implementation guide.
Unique id for the element within a resource (for internal references). This may be any
string value that does not contain spaces.
The definition may point directly to a computable or human-readable definition of the
extensibility codes, or it may be a logical URI as declared in some other specification.
The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://
hl7.org/fhir/extensibility.html) for a list).
Identifies a profile structure or implementation Guide that applies to the datatype this
element refers to. If any profiles are specified, then the content must conform to at
least one of them. The URL can be a local reference - to a contained StructureDefinition,
or a reference to another StructureDefinition or Implementation Guide by a canonical URL.
When an implementation guide is specified, the type SHALL conform to at least one profile
defined in the implementation guide.
</
StructureDefinition
>
Usage
note:
every
effort
has
been
made
to
ensure
that
This
is
a
representation
of
the
examples
are
correct
and
useful,
but
they
are
not
json
schema
for
SupplyDelivery,
which
is
just
a
normative
part
of
the
specification.
full
JSON
Schema
.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/SupplyDelivery",
"$ref": "#/definitions/SupplyDelivery",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"SupplyDelivery": {
"description": "Record of delivery of what is supplied.",
"properties": {
"resourceType": {
"description": "This is a SupplyDelivery resource",
"const": "SupplyDelivery"
},
"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, 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. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Identifier for the supply delivery event that is used to identify it across multiple disparate systems.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"basedOn": {
"description": "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"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 dispense event.",
"enum": [
"in-progress",
"completed",
"abandoned",
"entered-in-error"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"patient": {
"description": "A link to a resource representing the person whom the delivered item is for.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": {
"description": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"suppliedItem": {
"description": "The item that is being delivered or has been supplied.",
"$ref": "#/definitions/SupplyDelivery_SuppliedItem"
},
"occurrenceDateTime": {
"description": "The date or time(s) the activity occurred.",
"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"
},
"_occurrenceDateTime": {
"description": "Extensions for occurrenceDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"occurrencePeriod": {
"description": "The date or time(s) the activity occurred.",
"$ref": "Period.schema.json#/definitions/Period"
},
"occurrenceTiming": {
"description": "The date or time(s) the activity occurred.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"supplier": {
"description": "The individual responsible for dispensing the medication, supplier or device.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"destination": {
"description": "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"receiver": {
"description": "Identifies the person who picked up the Supply.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"SupplyDelivery_SuppliedItem": {
"description": "Record of delivery of what is supplied.",
"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. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"quantity": {
"description": "The amount of supply that has been dispensed. Includes unit of measure.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"itemCodeableConcept": {
"description": "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"itemReference": {
"description": "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"additionalProperties": false
}
}
}
®©
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
Mixed
Nomative/Trial
Use
Ballot
(v3.3.0-13671)
generated
on
Fri,
Nov
1,
2019
09:33+1100.
Tue,
Apr
3,
2018
12:18+1000.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
R3
DSTU3
|
|
Propose
a
change