Conformance
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0:
R5
-
STU
).
The
This
is
the
current
published
version
which
supercedes
in
it's
permanent
home
(it
will
always
be
available
at
this
version
is
5.0.0
.
URL).
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R5
R4B
R4
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative |
Raw XML ( canonical form + also see XML Format Specification )
Operation Definition
<?xml version="1.0" encoding="UTF-8"?>Generates a instance with a snapshot, based on a differential in a specified . If the operation is not called at the instance level, either or '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. The is provided directly as part of the request. Servers may choose not to accept profiles in this fashion ( ) 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.<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="StructureDefinition-snapshot"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p> URL: [base]/StructureDefinition/$snapshot</p> <p> URL: [base]/StructureDefinition/[id]/$snapshot</p> <p> Parameters</p> <table class="grid"> <tr> <td> <b> Use</b> </td> <td> <b> Name</b> </td> <td> <b> Scope</b> </td> <td> <b> Cardinality</b> </td> <td> <b> Type</b> </td> <td> <b> Binding</b> </td> <td> <b> Documentation</b> </td> </tr> <tr> <td> IN</td> <td> definition</td> <td> type</td> <td> 0..1</td> <td> <a href="structuredefinition.html">StructureDefinition</a> </td> <td/> <td> <div> <p> The <a href="structuredefinition.html">StructureDefinition</a> is provided directly as part of the request. Servers may choose not to accept profiles in this fashion </p> </div> </td> </tr> <tr> <td> IN</td> <td> url</td> <td> type</td> <td> 0..1</td> <td> <a href="datatypes.html#string">string</a> <br/> ( <a href="search.html#token">token</a> ) </td> <td/> <td> <div> <p> 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.</p> </div> </td> </tr> <tr> <td> OUT</td> <td> return</td> <td/> <td> 1..1</td> <td> <a href="structuredefinition.html">StructureDefinition</a> </td> <td/> <td> <div> <p> The structure definition with a snapshot</p> </div> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="5"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <url value="http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot"/> <version value="5.0.0"/> <name value="Snapshot"/> <title value="Generate Snapshot"/> <status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2023-03-26T15:21:02+11:00"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="Generates a [StructureDefinition](structuredefinition.html) instance with a snapshot, based on a differential in a specified [StructureDefinition](structuredefinition.html).If 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. The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion 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.If 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."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <affectsState value="true"/> <code value="snapshot"/> <resource value="StructureDefinition"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="definition"/> <use value="in"/> <scope value="type"/> <min value="0"/> <max value="1"/> <documentation value="The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion"/> <type value="StructureDefinition"/> </parameter> <parameter> <name value="url"/> <use value="in"/> <scope value="type"/> <min value="0"/> <max value="1"/> <documentation value="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 value="string"/> <searchType value="token"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The structure definition with a snapshot"/> <type value="StructureDefinition"/> </parameter> </ OperationDefinition >
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
hl7.fhir.core#5.0.0
generated
on
Sat,
May
28,
2022
12:57+1000.
Sun,
Mar
26,
2023
15:26+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
|
Compare
to
R4B
|
|
Propose
a
change