This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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 R3 R2

• Content
• Detailed Descriptions
• Operations

1.10.6 Resource Resource - Operations

This resource has 4 operations associated with it. For more information about operations, including how they are invoked, see Operations.

1.10.6.1 Validate a resource

The validate interaction checks whether the attached content would be acceptable either generally, or as a create, or an update or delete to an existing resource.

The action the server takes depends on the mode parameter:

• [missing]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules
• create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not validate any uniqueness constraints)
• update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate)
• delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules)

Modes update and delete can only be used when the operation is invoked at the resource level.

The return from this operation is an OperationOutcome

Formal Definition (as a OperationDefinition).

URL: [base]/Resource/$validate

URL: [base]/Resource/[id]/$validate

This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog, and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to succesfully perform an actual create, update or delete after the validation operation completes.

1.10.6.2 Access a list of profiles, tags, and security labels

This operation retrieves a summary of the profiles, tags, and security labels for the given scope. E.g. for each scope:

• system-wide: a list of all profiles, tags and security labels in use by the system
• resource-type level: A list of all profiles, tags, and security labels for the resource type
• individual resource level: A list of all profiles, tags, and security labels for the current version of the resource.

Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)

Formal Definition (as a OperationDefinition).

URL: [base]/$meta

URL: [base]/Resource/$meta

URL: [base]/Resource/[id]/$meta

At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principle use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't)

At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons

1.10.6.3 Add profiles, tags, and security labels to a resource

This operation takes a meta, and either adds the profiles, tags, and security labels found in it to the nominated resource.

This operation can also be used on historical entries - to update them without creating a different historical version

Formal Definition (as a OperationDefinition).

URL: [base]/Resource/[id]/$meta-add

This operation is special in that executing this operation does not cause a new version of the resource to be created. The meta is updated directly. This is because the content in meta does not affect the meaning of the resource, and the security labels (in particular) are used to apply access rules to existing versions of resources

1.10.6.4 Delete profiles, tags, and security labels for a resource

This operation takes a meta, and either deletes the profiles, tags, and security labels found in it from the nominated resource.

This operation can also be used on historical entries

Formal Definition (as a OperationDefinition).

URL: [base]/Resource/[id]/$meta-delete

This operation is special in that executing this operation does not cause a new version of the resource to be created. The meta is updated directly. This is because the content in meta does not affect the meaning of the resource, and the security labels (in particular) are used to apply access rules to existing versions of resources