FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.application-feature
Resource TypeOperationDefinition
IdOperationDefinition-CapabilityStatement-implements.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/HL7/capstmt/OperationDefinition-CapabilityStatement-implements.html
URLhttp://hl7.org/fhir/uv/application-feature/OperationDefinition/CapabilityStatement-implements
Version1.0.0
Statusactive
Date2021-01-05T10:01:24+11:00
NameImplements
TitleTest if a server implements a client's required operations
Realmuv
Authorityhl7
DescriptionThis operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition CapabilityStatement-implements

Last updated: 2021-01-05 10:01:24+1100

URL: [base]/CapabilityStatement/$implements

URL: [base]/CapabilityStatement/[id]/$implements

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INserver0..1canonical

A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)

INclient0..1canonical

A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)

INresource0..1CapabilityStatement

The client capability statement, provided inline

OUTreturn1..1OperationOutcome

Outcome of the CapabilityStatement test

The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided Technically, this operation is implemented as follows:

  • The server's capability statement must have an entry for each resource in the client's capability statement
  • The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude
  • The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)
  • The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement
  • The server must have an operation definition with a matching reference for any operations in the client capability statement

If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error


Source1

{
  "resourceType": "OperationDefinition",
  "id": "CapabilityStatement-implements",
  "meta": {
    "lastUpdated": "2021-01-05T10:01:24.148+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 5
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "extension": [
        {
          "url": "list",
          "valueString": "1"
        },
        {
          "url": "response",
          "valueBoolean": false
        },
        {
          "url": "content",
          "valueString": "$implements-request.txt"
        }
      ],
      "url": "http://hl7.org/fhir/build/StructureDefinition/example"
    },
    {
      "extension": [
        {
          "url": "list",
          "valueString": "1"
        },
        {
          "url": "response",
          "valueBoolean": true
        },
        {
          "url": "content",
          "valueString": "$implements-response.txt"
        }
      ],
      "url": "http://hl7.org/fhir/build/StructureDefinition/example"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/footer",
      "valueMarkdown": "The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided    Technically, this operation is implemented as follows:   \n\n* The server's capability statement must have an entry for each resource in the client's capability statement    \n* The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude   \n* The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)   \n* The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement   \n* The server must have an operation definition with a matching reference for any operations in the client capability statement   \n\nIf the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    }
  ],
  "url": "http://hl7.org/fhir/uv/application-feature/OperationDefinition/CapabilityStatement-implements",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.32.4"
    }
  ],
  "version": "1.0.0",
  "name": "Implements",
  "title": "Test if a server implements a client's required operations",
  "status": "active",
  "kind": "operation",
  "date": "2021-01-05T10:01:24+11:00",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "affectsState": false,
  "code": "implements",
  "comment": "The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided    Technically, this operation is implemented as follows:   \n\n* The server's capability statement must have an entry for each resource in the client's capability statement    \n* The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude   \n* The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)   \n* The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement   \n* The server must have an operation definition with a matching reference for any operations in the client capability statement   \n\nIf the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error",
  "resource": [
    "CapabilityStatement"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "server",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)",
      "type": "canonical"
    },
    {
      "name": "client",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)",
      "type": "canonical"
    },
    {
      "name": "resource",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The client capability statement, provided inline",
      "type": "CapabilityStatement"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Outcome of the CapabilityStatement test",
      "type": "OperationOutcome"
    }
  ]
}