R6 Checklist for Resource

Artifact Resource (Resource)

Urgent Item Checklist

All Analysis Information

The following content was generated to assist in the review of this artifact for R6 compliance.

Information Page

General Information:

Page File Name resource-introduction.xml
Responsible Workgroup fhir
Maturity Label Active
Maturity Level 5
Standards Status normative
Management Comments
Workgroup Comments
Exists In publish.ini No
Exists In Source Directory Yes
'deprecated' Literal Count 0
Zulip Link Count 0
Confluence Link Count 0

Conformance Language Summary

'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.

Literal Conformant Non-Conformant
SHALL 2 0
SHALL NOT 1 0
SHOULD 0 0
SHOULD NOT 0 0
MAY 0 2
MAY NOT 0 0

Possibly Removed FHIR Artifact Literals Found on Page

Word Artifact Class

Unknown Words Found on Page

Word Known Typo
recourcesNo

Images with Issues

Source Missing Alt Text Not In Figure Tag

Possible Incomplete Markers Found on Page

Reader Review Notes Found on Page

Notes Page

General Information:

Page File Name resource-notes.xml
Responsible Workgroup fhir
Maturity Label Active
Maturity Level 5
Standards Status normative
Management Comments
Workgroup Comments
Exists In publish.ini No
Exists In Source Directory Yes
'deprecated' Literal Count 0
Zulip Link Count 0
Confluence Link Count 0

Conformance Language Summary

'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.

Literal Conformant Non-Conformant
SHALL 4 0
SHALL NOT 1 0
SHOULD 9 6
SHOULD NOT 2 1
MAY 2 18
MAY NOT 0 0

Possibly Removed FHIR Artifact Literals Found on Page

Word Artifact Class
Provenance.entity.what[x]Element

Unknown Words Found on Page

Word Known Typo
'x2'.No
AllSecurityLabelsNo
Amoxycillin,No
CommonTagsNo
OBR:No
Resource.meta.versionIdNo
ValueSet.meta.versionIdNo
businesYes
commitedYes
doesn'tYes
firewalls)No
identiityNo
implicitRulesNo
lastUpdatedNo
lifecycles.No
timezoneNo
versionIdNo
x1,No
x2,No
xlp:MetaNo
ΣNo

Images with Issues

Source Missing Alt Text Not In Figure Tag
help.pngNoYes
help16.pngNoYes
icon_datatype.gifNoYes
icon_element.gifNoYes
icon_primitive.pngNoYes
icon_reference.pngNoYes
tbl_spacer.pngNoYes
tbl_vjoin.pngNoYes
tbl_vjoin_end.pngNoYes

Possible Incomplete Markers Found on Page

Reader Review Notes Found on Page

Element Review

Path Is Required Not Array Trial Use Has fixed[x] Has pattern[x] Required Binding External Required Binding Check meaningWhenMissing Is Modifier
Resource X
Resource.id
Resource.meta
Resource.implicitRules X
Resource.language optional - NO 'other' or 'unknown' X

Operations

Id Name Publication Status FMM Standards Status IsExperimental Workgroup Description
Resource-add Add Draft 0 trial-use False fhir Add content to an array in a large resource such as List or Group. See [Operations for Large Resources](http://hl7.org/fhir/R6/operations-for-large-resources.html).
Resource-convert Convert Draft 1 draft False fhir This operation takes a resource in one form, and returns to in another form. Both the `resource` and `return` parameters are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)
Resource-filter Filter Draft 0 trial-use False fhir Filter content from an array in a large resource such as List or Group. See [Operations for Large Resources](http://hl7.org/fhir/R6/operations-for-large-resources.html).
Resource-graph Graph Draft 1 trial-use False fhir Return an entire graph of resources based on a [GraphDefinition](http://hl7.org/fhir/R6/graphdefinition.html). The operation is invoked on a specific instance of a resource, and the graph definition tells the server what other resources to return in the same packaage
Resource-graphql Graphql Draft 1 trial-use False fhir Execute a graphql statement on a since resource or against the entire system. See the [Using GraphQL with FHIR](http://hl7.org/fhir/R6/graphql.html) page for further details. For the purposes of graphQL compatibility, this operation can also be invoked using a POST with the graphQL as the body, or a JSON body (see [graphQL spec](http://graphql.org/) for details)
Resource-meta Meta Draft 3 trial-use False fhir 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)
Resource-meta-add MetaAdd Draft 3 trial-use False fhir This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource
Resource-meta-delete MetaDelete Draft 3 trial-use False fhir This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource
Resource-remove Remove Draft 0 trial-use False fhir Remove content from an array in a large resource such as List or Group. See [Operations for Large Resources](http://hl7.org/fhir/R6/operations-for-large-resources.html).
Resource-validate Validate Active 5 normative False fhir The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: * [mode not provided]: 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 violate 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 instance level. The return from this operation is an [OperationOutcome](http://hl7.org/fhir/R6/operationoutcome.html) Note that this operation is not the only way to validate resources - see [Validating Resources](http://hl7.org/fhir/R6/validation.html) for further information.

Search Parameters

Id Name Publication Status FMM Standards Status IsExperimental WorkGroup Search Type Description
Resource-content _content Draft trial-use False fhir special Search on the entire content of the resource
Resource-filter _filter Draft trial-use False fhir special Filter search parameter which supports a more sophisticated grammar for searching. See [documentation](http://hl7.org/fhir/R6/search_filter.html) for further details
Resource-has _has Draft trial-use False fhir special Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
Resource-id _id Active normative False fhir token Logical id of this artifact
Resource-in _in Draft trial-use False fhir reference Allows for the retrieval of resources that are active members of a CareTeam, Group, or List
Resource-language _language Draft trial-use False fhir token Language of the resource content
Resource-lastUpdated _lastUpdated Active normative False fhir date When the resource version last changed
Resource-list _list Draft trial-use False fhir special Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists
Resource-profile _profile Active normative False fhir reference Profiles this resource claims to conform to
Resource-query _query Draft trial-use False fhir special A custom search profile that describes a specific defined query operation
Resource-security _security Draft trial-use False fhir token Security Labels applied to this resource
Resource-source _source Active normative False fhir uri Identifies where the resource comes from
Resource-tag _tag Draft trial-use False fhir token Tags applied to this resource
Resource-text _text Active string Search the narrative content of a resource.
Resource-type _type Draft trial-use False fhir special A resource type filter
example IDSEARCHPARAMETER Draft True fhir token Search by resource identifier - e.g. same as the read interaction, but can return included resources
filter FilterSearchParameter Draft False fhir special This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html)