This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#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
| FHIR Infrastructure Work Group | Maturity Level : N/A | Ballot Status : Informative | Compartments : Not linked to any defined compartments |
Raw JSON ( canonical form + also see JSON Format Specification )
Operation Definition
{
"resourceType": "OperationDefinition",
"id": "StructureDefinition-snapshot",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"resourceType" : "OperationDefinition",
"id" : "StructureDefinition-snapshot",
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 5
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
}
],
"url": "http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot",
"name": "Generate Snapshot",
"status": "draft",
"kind": "operation",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Generates a [StructureDefinition](structuredefinition.html) instance with a snapshot, based on a differential in a specified [StructureDefinition](structuredefinition.html). \n\nIf the operation is not called at the instance level, either *definition* or *url* 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.",
"code": "snapshot",
"resource": [
"StructureDefinition"
],
"system": false,
"type": true,
"instance": true,
"parameter": [
{
"name": "definition",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion",
"type": "StructureDefinition",
"searchType": "token"
},
{
"name": "url",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The profile's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.",
"type": "string",
"searchType": "token"
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "Trial Use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot",
"name" : "Generate Snapshot",
"status" : "draft",
"kind" : "operation",
"date" : "2018-08-19T21:48:56+10:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The structure definition with a snapshot",
"type": "StructureDefinition"
}
]
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
}],
"description" : "Generates a [StructureDefinition](structuredefinition.html) instance with a snapshot, based on a differential in a specified [StructureDefinition](structuredefinition.html). \n\nIf the operation is not called at the instance level, either *definition* or *url* 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.",
"code" : "snapshot",
"resource" : ["StructureDefinition"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "definition",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion",
"type" : "StructureDefinition"
},
{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The structure definition with a snapshot",
"type" : "StructureDefinition"
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.