Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

5.4.12.2 Operation $snapshot on StructureDefinition

FHIR Infrastructure icon Work Group Maturity Level: 5Trial Use Compartments: N/A

Generates a StructureDefinition instance with a snapshot, based on a differential in a specified StructureDefinition.

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 canonical URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot

Formal Definition (as a OperationDefinition).

URL: [base]/StructureDefinition/$snapshot

URL: [base]/StructureDefinition/[id]/$snapshot

This is not an idempotent operation

In Parameters:
NameScopeCardinalityTypeBindingProfileDocumentation
definitiontype0..1StructureDefinition

The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion

urltype0..1string
(token)

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.

Out Parameters:
NameScopeCardinalityTypeBindingProfileDocumentation
return1..1StructureDefinition

The structure definition with a snapshot

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

5.4.12.2.1 Examples

Request:

GET /fhir/StructureDefinition/daf-patient/$snapshot
Accept: application/fhir+json

Response:

HTTP/1.1 200 OK
Content-Type: application/fhir+json
[other headers]

{
  "ResourceType" : "StructureDefinition",
  ... (including snapshot) ...
}

 

For more information about operations, including how they are invoked, see Operations.