capability statements

Create Capability Statement

post
/organizations/{organizationId}/fhir/3/CapabilityStatement

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringCapabilityStatementThis is a CapabilityStatement resource
urlstringAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the capability statement.
statusstringdraft|active|retired|unknownThe status of this capability statement. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
publisherstringThe name of the individual or organization that published the capability statement.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the capability statement is intended to be used.
purposestringExplaination of why this capability statement is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
kindstringinstance|capability|requirementsThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
instantiatesarray()Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
softwareCapabilityStatement_SoftwareSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
implementationCapabilityStatement_ImplementationIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
fhirVersionstringThe version of the FHIR specification on which this capability statement is based.
acceptUnknownstringno|extensions|elements|bothA code that indicates whether the application accepts unknown elements or extensions when reading resources.
formatarray()A list of the formats supported by this implementation using their content types.
patchFormatarray()A list of the patch formats supported by this implementation using their content types.
implementationGuidearray()A list of implementation guides that the server does (or should) support in their entirety.
profilearray(Reference)A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
restarray(CapabilityStatement_Rest)A definition of the restful capabilities of the solution, if any.
messagingarray(CapabilityStatement_Messaging)A description of the messaging capabilities of the solution.
documentarray(CapabilityStatement_Document)A document definition.

Response

Patch Capability Statement

patch
/organizations/{organizationId}/fhir/3/CapabilityStatement/{resourceId}

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCapabilityStatementThis is a CapabilityStatement resource
urlstringAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the capability statement.
statusstringdraft|active|retired|unknownThe status of this capability statement. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
publisherstringThe name of the individual or organization that published the capability statement.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the capability statement is intended to be used.
purposestringExplaination of why this capability statement is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
kindstringinstance|capability|requirementsThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
instantiatesarray()Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
softwareCapabilityStatement_SoftwareSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
implementationCapabilityStatement_ImplementationIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
fhirVersionstringThe version of the FHIR specification on which this capability statement is based.
acceptUnknownstringno|extensions|elements|bothA code that indicates whether the application accepts unknown elements or extensions when reading resources.
formatarray()A list of the formats supported by this implementation using their content types.
patchFormatarray()A list of the patch formats supported by this implementation using their content types.
implementationGuidearray()A list of implementation guides that the server does (or should) support in their entirety.
profilearray(Reference)A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
restarray(CapabilityStatement_Rest)A definition of the restful capabilities of the solution, if any.
messagingarray(CapabilityStatement_Messaging)A description of the messaging capabilities of the solution.
documentarray(CapabilityStatement_Document)A document definition.

Response

Read Capability Statement

get
/organizations/{organizationId}/fhir/3/CapabilityStatement/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Capability Statement

get
/organizations/{organizationId}/fhir/3/CapabilityStatement/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Capability Statement

get
/organizations/{organizationId}/fhir/3/CapabilityStatement/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Capability Statement

delete
/organizations/{organizationId}/fhir/3/CapabilityStatement/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Capability Statement

get
/organizations/{organizationId}/fhir/3/CapabilityStatement

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
eventstring
fhirversionstring
formatstring
guidestring
jurisdictionstring
modestring
namestring
publisherstring
resourcestring
resource-profilestring
security-servicestring
softwarestring
statusstring
supported-profilestring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Capability Statement

get
/organizations/{organizationId}/fhir/3/CapabilityStatement/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Capability Statement

post
/organizations/{organizationId}/fhir/3/CapabilityStatement/_search

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
eventstring
fhirversionstring
formatstring
guidestring
jurisdictionstring
modestring
namestring
publisherstring
resourcestring
resource-profilestring
security-servicestring
softwarestring
statusstring
supported-profilestring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCapabilityStatementThis is a CapabilityStatement resource
urlstringAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the capability statement.
statusstringdraft|active|retired|unknownThe status of this capability statement. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
publisherstringThe name of the individual or organization that published the capability statement.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the capability statement is intended to be used.
purposestringExplaination of why this capability statement is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
kindstringinstance|capability|requirementsThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
instantiatesarray()Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
softwareCapabilityStatement_SoftwareSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
implementationCapabilityStatement_ImplementationIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
fhirVersionstringThe version of the FHIR specification on which this capability statement is based.
acceptUnknownstringno|extensions|elements|bothA code that indicates whether the application accepts unknown elements or extensions when reading resources.
formatarray()A list of the formats supported by this implementation using their content types.
patchFormatarray()A list of the patch formats supported by this implementation using their content types.
implementationGuidearray()A list of implementation guides that the server does (or should) support in their entirety.
profilearray(Reference)A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
restarray(CapabilityStatement_Rest)A definition of the restful capabilities of the solution, if any.
messagingarray(CapabilityStatement_Messaging)A description of the messaging capabilities of the solution.
documentarray(CapabilityStatement_Document)A document definition.

Response

Update Capability Statement

put
/organizations/{organizationId}/fhir/3/CapabilityStatement/{resourceId}

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCapabilityStatementThis is a CapabilityStatement resource
urlstringAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the capability statement.
statusstringdraft|active|retired|unknownThe status of this capability statement. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
publisherstringThe name of the individual or organization that published the capability statement.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the capability statement is intended to be used.
purposestringExplaination of why this capability statement is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
kindstringinstance|capability|requirementsThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
instantiatesarray()Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
softwareCapabilityStatement_SoftwareSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
implementationCapabilityStatement_ImplementationIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
fhirVersionstringThe version of the FHIR specification on which this capability statement is based.
acceptUnknownstringno|extensions|elements|bothA code that indicates whether the application accepts unknown elements or extensions when reading resources.
formatarray()A list of the formats supported by this implementation using their content types.
patchFormatarray()A list of the patch formats supported by this implementation using their content types.
implementationGuidearray()A list of implementation guides that the server does (or should) support in their entirety.
profilearray(Reference)A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
restarray(CapabilityStatement_Rest)A definition of the restful capabilities of the solution, if any.
messagingarray(CapabilityStatement_Messaging)A description of the messaging capabilities of the solution.
documentarray(CapabilityStatement_Document)A document definition.

Response