R4 Ballot #1 (Mixed Normative/Trial use)
ConformanceThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for CapabilityStatement, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/CapabilityStatement",
"$ref": "#/definitions/CapabilityStatement",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"CapabilityStatement": {
"description": "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.",
"properties": {
"resourceType": {
"description": "This is a CapabilityStatement resource",
"const": "CapabilityStatement"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this capability statement is (or will be) published.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"version": {
"description": "The 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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "A 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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the capability statement.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this capability statement. Enables tracking the life-cycle of the content.",
"enum": [
"draft",
"active",
"retired",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "A 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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The date (and optionally time) when the capability statement was published. The date must change 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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual that published the capability statement.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the capability statement from a consumer\u0027s 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.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the capability statement is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this capability statement is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "A 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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"kind": {
"description": "The 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).",
"enum": [
"instance",
"capability",
"requirements"
]
},
"_kind": {
"description": "Extensions for kind",
"$ref": "Element.schema.json#/definitions/Element"
},
"instantiates": {
"description": "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.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"software": {
"description": "Software 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.",
"$ref": "#/definitions/CapabilityStatement_Software"
},
"implementation": {
"description": "Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"$ref": "#/definitions/CapabilityStatement_Implementation"
},
"fhirVersion": {
"description": "The version of the FHIR specification on which this capability statement is based.",
"$ref": "#/definitions/id"
},
"_fhirVersion": {
"description": "Extensions for fhirVersion",
"$ref": "Element.schema.json#/definitions/Element"
},
"format": {
"description": "A list of the formats supported by this implementation using their content types.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_format": {
"description": "Extensions for format",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"patchFormat": {
"description": "A list of the patch formats supported by this implementation using their content types.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_patchFormat": {
"description": "Extensions for patchFormat",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"implementationGuide": {
"description": "A list of implementation guides that the server does (or should) support in their entirety.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"rest": {
"description": "A definition of the restful capabilities of the solution, if any.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Rest"
},
"type": "array"
},
"messaging": {
"description": "A description of the messaging capabilities of the solution.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Messaging"
},
"type": "array"
},
"document": {
"description": "A document definition.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Document"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"CapabilityStatement_Software": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "Name the software is known by.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"version": {
"description": "The version identifier for the software covered by this statement.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"releaseDate": {
"description": "Date this version of the software was released.",
"$ref": "#/definitions/dateTime"
},
"_releaseDate": {
"description": "Extensions for releaseDate",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"CapabilityStatement_Implementation": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "Information about the specific installation that this capability statement relates to.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"url": {
"description": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"$ref": "#/definitions/url"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"CapabilityStatement_Rest": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.",
"enum": [
"client",
"server"
]
},
"_mode": {
"description": "Extensions for mode",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "Information about the system\u0027s restful capabilities that apply across all applications, such as security.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
},
"security": {
"description": "Information about security implementation from an interface perspective - what a client needs to know.",
"$ref": "#/definitions/CapabilityStatement_Security"
},
"resource": {
"description": "A specification of the restful capabilities of the solution for a specific resource type.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Resource"
},
"type": "array"
},
"interaction": {
"description": "A specification of restful operations supported by the system.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Interaction1"
},
"type": "array"
},
"searchParam": {
"description": "Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"items": {
"$ref": "#/definitions/CapabilityStatement_SearchParam"
},
"type": "array"
},
"operation": {
"description": "Definition of an operation or a named query together with its parameters and their meaning and type.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Operation"
},
"type": "array"
},
"compartment": {
"description": "An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
}
},
"additionalProperties": false
},
"CapabilityStatement_Security": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"cors": {
"description": "Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.",
"$ref": "#/definitions/boolean"
},
"_cors": {
"description": "Extensions for cors",
"$ref": "Element.schema.json#/definitions/Element"
},
"service": {
"description": "Types of security services that are supported/required by the system.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"description": {
"description": "General description of how security works.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"CapabilityStatement_Resource": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "A type of resource exposed via the restful interface.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"profile": {
"description": "A specification of the profile that describes the solution\u0027s overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"supportedProfile": {
"description": "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).",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"documentation": {
"description": "Additional information about the resource type used by the system.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
},
"interaction": {
"description": "Identifies a restful operation supported by the solution.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Interaction"
},
"type": "array"
},
"versioning": {
"description": "This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is \u0027versioned-update\u0027, then the server supports all the versioning features, including using e-tags for version integrity in the API.",
"enum": [
"no-version",
"versioned",
"versioned-update"
]
},
"_versioning": {
"description": "Extensions for versioning",
"$ref": "Element.schema.json#/definitions/Element"
},
"readHistory": {
"description": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"$ref": "#/definitions/boolean"
},
"_readHistory": {
"description": "Extensions for readHistory",
"$ref": "Element.schema.json#/definitions/Element"
},
"updateCreate": {
"description": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.",
"$ref": "#/definitions/boolean"
},
"_updateCreate": {
"description": "Extensions for updateCreate",
"$ref": "Element.schema.json#/definitions/Element"
},
"conditionalCreate": {
"description": "A flag that indicates that the server supports conditional create.",
"$ref": "#/definitions/boolean"
},
"_conditionalCreate": {
"description": "Extensions for conditionalCreate",
"$ref": "Element.schema.json#/definitions/Element"
},
"conditionalRead": {
"description": "A code that indicates how the server supports conditional read.",
"enum": [
"not-supported",
"modified-since",
"not-match",
"full-support"
]
},
"_conditionalRead": {
"description": "Extensions for conditionalRead",
"$ref": "Element.schema.json#/definitions/Element"
},
"conditionalUpdate": {
"description": "A flag that indicates that the server supports conditional update.",
"$ref": "#/definitions/boolean"
},
"_conditionalUpdate": {
"description": "Extensions for conditionalUpdate",
"$ref": "Element.schema.json#/definitions/Element"
},
"conditionalDelete": {
"description": "A code that indicates how the server supports conditional delete.",
"enum": [
"not-supported",
"single",
"multiple"
]
},
"_conditionalDelete": {
"description": "Extensions for conditionalDelete",
"$ref": "Element.schema.json#/definitions/Element"
},
"referencePolicy": {
"description": "A set of flags that defines how references are supported.",
"items": {
"enum": [
"literal",
"logical",
"resolves",
"enforced",
"local"
]
},
"type": "array"
},
"_referencePolicy": {
"description": "Extensions for referencePolicy",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"searchInclude": {
"description": "A list of _include values supported by the server.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_searchInclude": {
"description": "Extensions for searchInclude",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"searchRevInclude": {
"description": "A list of _revinclude (reverse include) values supported by the server.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_searchRevInclude": {
"description": "Extensions for searchRevInclude",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"searchParam": {
"description": "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"items": {
"$ref": "#/definitions/CapabilityStatement_SearchParam"
},
"type": "array"
},
"operation": {
"description": "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Operation"
},
"type": "array"
}
},
"additionalProperties": false
},
"CapabilityStatement_Interaction": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Coded identifier of the operation, supported by the system resource.",
"enum": [
"read",
"vread",
"update",
"patch",
"delete",
"history-instance",
"history-type",
"create",
"search-type"
]
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "Guidance specific to the implementation of this operation, such as \u0027delete is a logical delete\u0027 or \u0027updates are only allowed with version id\u0027 or \u0027creates permitted from pre-authorized certificates only\u0027.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"CapabilityStatement_SearchParam": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of the search parameter used in the interface.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"definition": {
"description": "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": {
"description": "The type of value a search parameter refers to, and how the content is interpreted.",
"enum": [
"number",
"date",
"string",
"token",
"reference",
"composite",
"quantity",
"uri"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"CapabilityStatement_Operation": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"definition": {
"description": "Where the formal definition can be found.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"documentation": {
"description": "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false,
"required": [
"definition"
]
},
"CapabilityStatement_Interaction1": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A coded identifier of the operation, supported by the system.",
"enum": [
"transaction",
"batch",
"search-system",
"history-system"
]
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"CapabilityStatement_Messaging": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"endpoint": {
"description": "An endpoint (network accessible address) to which messages and/or replies are to be sent.",
"items": {
"$ref": "#/definitions/CapabilityStatement_Endpoint"
},
"type": "array"
},
"reliableCache": {
"description": "Length if the receiver\u0027s reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"$ref": "#/definitions/unsignedInt"
},
"_reliableCache": {
"description": "Extensions for reliableCache",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "Documentation about the system\u0027s messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
},
"supportedMessage": {
"description": "References to message definitions for messages this system can send or receive.",
"items": {
"$ref": "#/definitions/CapabilityStatement_SupportedMessage"
},
"type": "array"
}
},
"additionalProperties": false
},
"CapabilityStatement_Endpoint": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"protocol": {
"description": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"address": {
"description": "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.",
"$ref": "#/definitions/url"
},
"_address": {
"description": "Extensions for address",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false,
"required": [
"protocol"
]
},
"CapabilityStatement_SupportedMessage": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "The mode of this event declaration - whether application is sender or receiver.",
"enum": [
"sender",
"receiver"
]
},
"_mode": {
"description": "Extensions for mode",
"$ref": "Element.schema.json#/definitions/Element"
},
"definition": {
"description": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"additionalProperties": false,
"required": [
"definition"
]
},
"CapabilityStatement_Document": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "Mode of this document declaration - whether an application is a producer or consumer.",
"enum": [
"producer",
"consumer"
]
},
"_mode": {
"description": "Extensions for mode",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.",
"$ref": "#/definitions/string"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
},
"profile": {
"description": "A profile on the document Bundle that constrains which resources are present, and their contents.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"additionalProperties": false,
"required": [
"profile"
]
}
}
}
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:13+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change