STU3 Candidate
ConformanceThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
StructureDefinition for capabilitystatement
{
"resourceType": "StructureDefinition",
"id": "CapabilityStatement",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"name": "CapabilityStatement",
"status": "draft",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for CapabilityStatement Resource",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "CapabilityStatement",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "CapabilityStatement",
"path": "CapabilityStatement",
"short": "A statement of system Capabilities",
"definition": "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.",
"min": 1,
"max": "1",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "cpb-8",
"severity": "error",
"human": "There can only be one REST declaration per mode",
"expression": "rest.select(mode).isDistinct()",
"xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"
},
{
"key": "cpb-7",
"severity": "error",
"human": "The set of documents must be unique by the combination of profile & mode",
"expression": "document.select(profile.reference&mode).isDistinct()",
"xpath": "count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value))"
},
{
"key": "cpb-15",
"severity": "error",
"human": "Capability Statements of kind 'instance' do not have implementation elements",
"expression": "implementation.empty() or kind != 'capability'",
"xpath": "not(exists(f:implementation)) or (f:kind/@value != 'capability')"
},
{
"key": "cpb-3",
"severity": "error",
"human": "Messaging end-point is required (and is only permitted) when statement is for an implementation",
"expression": "messaging.endpoint.empty() or kind = 'instance'",
"xpath": "not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance'"
},
{
"key": "cpb-14",
"severity": "error",
"human": "Capability Statements of kind 'requirements' do not have software or implementation elements",
"expression": "(software.empty() and implementation.empty()) or kind != 'requirements'",
"xpath": "not(exists(f:software) or exists(f:implementation)) or (f:kind/@value != 'requirements')"
},
{
"key": "cpb-2",
"severity": "error",
"human": "A Capability Statement SHALL have at least one of description, software, or implementation",
"expression": "(description.count() + software.count() + implementation.count()) > 0",
"xpath": "count(f:software | f:implementation | f:description) > 0"
},
{
"key": "cpb-1",
"severity": "error",
"human": "A Capability Statement SHALL have at least one of REST, messaging or document",
"expression": "rest.exists() or messaging.exists() or document.exists()",
"xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"id": "CapabilityStatement.id",
"path": "CapabilityStatement.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.meta",
"path": "CapabilityStatement.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.implicitRules",
"path": "CapabilityStatement.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "CapabilityStatement.language",
"path": "CapabilityStatement.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "CapabilityStatement.text",
"path": "CapabilityStatement.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "CapabilityStatement.contained",
"path": "CapabilityStatement.contained",
"short": "Contained, inline Resources",
"definition": "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.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.extension",
"path": "CapabilityStatement.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.modifierExtension",
"path": "CapabilityStatement.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.url",
"path": "CapabilityStatement.url",
"short": "Logical uri to reference this capability statement (globally unique)",
"definition": "An absolute URL 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).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the capability statement to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "CapabilityStatement.version",
"path": "CapabilityStatement.version",
"short": "Business version of the capability statement",
"definition": "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 are orderable.",
"comments": "There may be multiple different instances of a capability statement that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "CapabilityStatement.name",
"path": "CapabilityStatement.name",
"short": "Name for this capability statement (Computer friendly)",
"definition": "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.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.title",
"path": "CapabilityStatement.title",
"short": "Name for this capability statement (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the capability statement.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.status",
"path": "CapabilityStatement.status",
"short": "draft | active | retired",
"definition": "The status of this capability statement. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of capability statement that are appropriate for use vs. not. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CapabilityStatement.experimental",
"path": "CapabilityStatement.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag 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.",
"comments": "Allows filtering of capability statement that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level capability statement would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "CapabilityStatement.date",
"path": "CapabilityStatement.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the capability statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "CapabilityStatement.publisher",
"path": "CapabilityStatement.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the capability statement.",
"comments": "Usually an organization, but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the capability statement. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "CapabilityStatement.contact",
"path": "CapabilityStatement.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.description",
"path": "CapabilityStatement.description",
"short": "Natural language description of the capability statement",
"definition": "A free text natural language description of the capability statement from the 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.",
"comments": "This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"condition": [
"cpb-2"
]
},
{
"id": "CapabilityStatement.useContext",
"path": "CapabilityStatement.useContext",
"short": "Content intends to support these contexts",
"definition": "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 of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.jurisdiction",
"path": "CapabilityStatement.jurisdiction",
"short": "Intended jurisdiction for capability statement (if applicable)",
"definition": "A jurisdiction in which the capability statement is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "CapabilityStatement.purpose",
"path": "CapabilityStatement.purpose",
"short": "Why this capability statement is defined",
"definition": "Explains why this capability statement is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the capability statement (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CapabilityStatement.copyright",
"path": "CapabilityStatement.copyright",
"short": "Use and/or publishing restrictions",
"definition": "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.",
"requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the capability statement and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "CapabilityStatement.kind",
"path": "CapabilityStatement.kind",
"short": "instance | capability | requirements",
"definition": "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).",
"requirements": "Allow searching the 3 modes.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "How a capability statement is intended to be used.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/capability-statement-kind"
}
}
},
{
"id": "CapabilityStatement.instantiates",
"path": "CapabilityStatement.instantiates",
"short": "Canonical URL of another capability statement this implements",
"definition": "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.",
"comments": "HL7 defines the following Services: [Terminology Service](terminology-service.html)\n\nMany [Implementation Guides](https://registry.fhir.org/guides) define additional services.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software",
"path": "CapabilityStatement.software",
"short": "Software that is covered by this capability statement",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software.id",
"path": "CapabilityStatement.software.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.software.extension",
"path": "CapabilityStatement.software.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.software.modifierExtension",
"path": "CapabilityStatement.software.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.software.name",
"path": "CapabilityStatement.software.name",
"short": "A name the software is known by",
"definition": "Name software is known by.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software.version",
"path": "CapabilityStatement.software.version",
"short": "Version covered by this statement",
"definition": "The version identifier for the software covered by this statement.",
"comments": "If possible, version should be specified, as statements are likely to be different for different versions of software.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software.releaseDate",
"path": "CapabilityStatement.software.releaseDate",
"short": "Date this version released",
"definition": "Date this version of the software released.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.implementation",
"path": "CapabilityStatement.implementation",
"short": "If this describes a specific instance",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.implementation.id",
"path": "CapabilityStatement.implementation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.implementation.extension",
"path": "CapabilityStatement.implementation.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.implementation.modifierExtension",
"path": "CapabilityStatement.implementation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.implementation.description",
"path": "CapabilityStatement.implementation.description",
"short": "Describes this specific instance",
"definition": "Information about the specific installation that this capability statement relates to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.implementation.url",
"path": "CapabilityStatement.implementation.url",
"short": "Base URL for the installation",
"definition": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.fhirVersion",
"path": "CapabilityStatement.fhirVersion",
"short": "FHIR Version the system uses",
"definition": "The version of the FHIR specification on which this capability statement is based.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.acceptUnknown",
"path": "CapabilityStatement.acceptUnknown",
"short": "no | extensions | elements | both",
"definition": "A code that indicates whether the application accepts unknown elements or extensions when reading resources.",
"comments": "Unknown elements in a resource can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence accepting unknown elements is about inter-version compatibility.\n\nApplications are recommended to accept unknown extensions and elements ('both'), but this is not always possible.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "A code that indicates whether an application accepts unknown elements or extensions when reading resources.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/unknown-content-code"
}
}
},
{
"id": "CapabilityStatement.format",
"path": "CapabilityStatement.format",
"short": "formats supported (xml | json | ttl | mime type)",
"definition": "A list of the formats supported by this implementation using their content types.",
"comments": "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "CapabilityStatement.patchFormat",
"path": "CapabilityStatement.patchFormat",
"short": "Patch formats supported",
"definition": "A list of the patch formats supported by this implementation using their content types.",
"comments": "At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats matching the formats it supports, but this is not always possible or necessary.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "CapabilityStatement.implementationGuide",
"path": "CapabilityStatement.implementationGuide",
"short": "Implementation Guide supported",
"definition": "A list of implementation guides that the server does (or should) support in their entirety.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.profile",
"path": "CapabilityStatement.profile",
"short": "Profiles for use cases supported",
"definition": "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).",
"comments": "Supported profiles are different to the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). Typical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However, they do not need to describe more than one resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest",
"path": "CapabilityStatement.rest",
"short": "If the endpoint is a RESTful one",
"definition": "A definition of the restful capabilities of the solution, if any.",
"comments": "Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "cpb-9",
"severity": "error",
"human": "A given resource can only be described once per RESTful mode",
"expression": "resource.select(type).isDistinct()",
"xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.id",
"path": "CapabilityStatement.rest.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.extension",
"path": "CapabilityStatement.rest.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.modifierExtension",
"path": "CapabilityStatement.rest.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.mode",
"path": "CapabilityStatement.rest.mode",
"short": "client | server",
"definition": "Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The mode of a RESTful capability statement.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/restful-capability-mode"
}
}
},
{
"id": "CapabilityStatement.rest.documentation",
"path": "CapabilityStatement.rest.documentation",
"short": "General description of implementation",
"definition": "Information about the system's restful capabilities that apply across all applications, such as security.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.security",
"path": "CapabilityStatement.rest.security",
"short": "Information about security of implementation",
"definition": "Information about security implementation from an interface perspective - what a client needs to know.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.security.id",
"path": "CapabilityStatement.rest.security.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.security.extension",
"path": "CapabilityStatement.rest.security.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.security.modifierExtension",
"path": "CapabilityStatement.rest.security.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.security.cors",
"path": "CapabilityStatement.rest.security.cors",
"short": "Adds CORS Headers (http://enable-cors.org/)",
"definition": "Server adds CORS headers when responding to requests - this enables javascript applications to use the server.",
"comments": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.security.service",
"path": "CapabilityStatement.rest.security.service",
"short": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates",
"definition": "Types of security services are supported/required by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Types of security services used with FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/restful-security-service"
}
}
},
{
"id": "CapabilityStatement.rest.security.description",
"path": "CapabilityStatement.rest.security.description",
"short": "General description of how security works",
"definition": "General description of how security works.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate",
"path": "CapabilityStatement.rest.security.certificate",
"short": "Certificates associated with security profiles",
"definition": "Certificates associated with security profiles.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate.id",
"path": "CapabilityStatement.rest.security.certificate.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate.extension",
"path": "CapabilityStatement.rest.security.certificate.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate.modifierExtension",
"path": "CapabilityStatement.rest.security.certificate.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate.type",
"path": "CapabilityStatement.rest.security.certificate.type",
"short": "Mime type for certificate",
"definition": "Mime type for certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "CapabilityStatement.rest.security.certificate.blob",
"path": "CapabilityStatement.rest.security.certificate.blob",
"short": "Actual certificate",
"definition": "Actual certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"id": "CapabilityStatement.rest.resource",
"path": "CapabilityStatement.rest.resource",
"short": "Resource served on the REST interface",
"definition": "A specification of the restful capabilities of the solution for a specific resource type.",
"comments": "Max of one repetition per resource type.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "cpb-12",
"severity": "error",
"human": "Search parameter names must be unique in the context of a resource",
"expression": "searchParam.select(name).isDistinct()",
"xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.resource.id",
"path": "CapabilityStatement.rest.resource.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.resource.extension",
"path": "CapabilityStatement.rest.resource.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.resource.modifierExtension",
"path": "CapabilityStatement.rest.resource.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.resource.type",
"path": "CapabilityStatement.rest.resource.type",
"short": "A resource type that is supported",
"definition": "A type of resource exposed via the restful interface.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "CapabilityStatement.rest.resource.profile",
"path": "CapabilityStatement.rest.resource.profile",
"short": "Base System profile for all uses of resource",
"definition": "A specification of the profile that describes the solution's 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}.",
"comments": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.resource.documentation",
"path": "CapabilityStatement.rest.resource.documentation",
"short": "Additional information about the use of the resource type",
"definition": "Additional information about the resource type is used by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ResourceInteraction"
}
],
"path": "CapabilityStatement.rest.resource.interaction",
"short": "What operations are supported?",
"definition": "Identifies a restful operation supported by the solution.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction.id",
"path": "CapabilityStatement.rest.resource.interaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction.extension",
"path": "CapabilityStatement.rest.resource.interaction.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction.modifierExtension",
"path": "CapabilityStatement.rest.resource.interaction.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction.code",
"path": "CapabilityStatement.rest.resource.interaction.code",
"short": "read | vread | update | patch | delete | history-instance | history-type | create | search-type",
"definition": "Coded identifier of the operation, supported by the system resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Operations supported by REST at the type or instance level.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/type-restful-interaction"
}
}
},
{
"id": "CapabilityStatement.rest.resource.interaction.documentation",
"path": "CapabilityStatement.rest.resource.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"requirements": "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.versioning",
"path": "CapabilityStatement.rest.resource.versioning",
"short": "no-version | versioned | versioned-update",
"definition": "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 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.",
"comments": "If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "How the system supports versioning for a resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/versioning-policy"
}
}
},
{
"id": "CapabilityStatement.rest.resource.readHistory",
"path": "CapabilityStatement.rest.resource.readHistory",
"short": "Whether vRead can return past versions",
"definition": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comments": "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.updateCreate",
"path": "CapabilityStatement.rest.resource.updateCreate",
"short": "If update can commit to a new identity",
"definition": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. 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.",
"comments": "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.conditionalCreate",
"path": "CapabilityStatement.rest.resource.conditionalCreate",
"short": "If allows/uses conditional create",
"definition": "A flag that indicates that the server supports conditional create.",
"comments": "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.conditionalRead",
"path": "CapabilityStatement.rest.resource.conditionalRead",
"short": "not-supported | modified-since | not-match | full-support",
"definition": "A code that indicates how the server supports conditional read.",
"comments": "Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A code that indicates how the server supports conditional read.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conditional-read-status"
}
}
},
{
"id": "CapabilityStatement.rest.resource.conditionalUpdate",
"path": "CapabilityStatement.rest.resource.conditionalUpdate",
"short": "If allows/uses conditional update",
"definition": "A flag that indicates that the server supports conditional update.",
"comments": "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.conditionalDelete",
"path": "CapabilityStatement.rest.resource.conditionalDelete",
"short": "not-supported | single | multiple - how conditional delete is supported",
"definition": "A code that indicates how the server supports conditional delete.",
"comments": "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A code that indicates how the server supports conditional delete.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conditional-delete-status"
}
}
},
{
"id": "CapabilityStatement.rest.resource.referencePolicy",
"path": "CapabilityStatement.rest.resource.referencePolicy",
"short": "literal | logical | resolves | enforced | local",
"definition": "A set of flags that defines how references are supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A set of flags that defines how references are supported",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reference-handling-policy"
}
}
},
{
"id": "CapabilityStatement.rest.resource.searchInclude",
"path": "CapabilityStatement.rest.resource.searchInclude",
"short": "_include values supported by the server",
"definition": "A list of _include values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchRevInclude",
"path": "CapabilityStatement.rest.resource.searchRevInclude",
"short": "_revinclude values supported by the server",
"definition": "A list of _revinclude (reverse include) values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam",
"path": "CapabilityStatement.rest.resource.searchParam",
"short": "Search params supported by implementation",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.id",
"path": "CapabilityStatement.rest.resource.searchParam.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.extension",
"path": "CapabilityStatement.rest.resource.searchParam.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.modifierExtension",
"path": "CapabilityStatement.rest.resource.searchParam.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.name",
"path": "CapabilityStatement.rest.resource.searchParam.name",
"short": "Name of search parameter",
"definition": "The name of the search parameter used in the interface.",
"comments": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.definition",
"path": "CapabilityStatement.rest.resource.searchParam.definition",
"short": "Source of definition for parameter",
"definition": "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]()).",
"comments": "This SHOULD be present, and matches refers to a SearchParameter by it's canonical url. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.type",
"path": "CapabilityStatement.rest.resource.searchParam.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"comments": "While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-param-type"
}
}
},
{
"id": "CapabilityStatement.rest.resource.searchParam.documentation",
"path": "CapabilityStatement.rest.resource.searchParam.documentation",
"short": "Server-specific usage",
"definition": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.interaction",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SystemInteraction"
}
],
"path": "CapabilityStatement.rest.interaction",
"short": "What operations are supported?",
"definition": "A specification of restful operations supported by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "CapabilityStatement.rest.interaction.id",
"path": "CapabilityStatement.rest.interaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.interaction.extension",
"path": "CapabilityStatement.rest.interaction.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.interaction.modifierExtension",
"path": "CapabilityStatement.rest.interaction.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.interaction.code",
"path": "CapabilityStatement.rest.interaction.code",
"short": "transaction | batch | search-system | history-system",
"definition": "A coded identifier of the operation, supported by the system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Operations supported by REST at the system level.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/system-restful-interaction"
}
}
},
{
"id": "CapabilityStatement.rest.interaction.documentation",
"path": "CapabilityStatement.rest.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.searchParam",
"path": "CapabilityStatement.rest.searchParam",
"short": "Search params for searching all resources",
"definition": "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.",
"comments": "Typically, the only search parameters supported for all parameters are search parameters that apply to all resources - tags, profiles, text search etc.",
"min": 0,
"max": "*",
"contentReference": "#CapabilityStatement.rest.resource.searchParam"
},
{
"id": "CapabilityStatement.rest.operation",
"path": "CapabilityStatement.rest.operation",
"short": "Definition of an operation or a custom query",
"definition": "Definition of an operation or a named query and with its parameters and their meaning and type.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.operation.id",
"path": "CapabilityStatement.rest.operation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.operation.extension",
"path": "CapabilityStatement.rest.operation.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.rest.operation.modifierExtension",
"path": "CapabilityStatement.rest.operation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.rest.operation.name",
"path": "CapabilityStatement.rest.operation.name",
"short": "Name by which the operation/query is invoked",
"definition": "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.",
"comments": "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the \"$\" portion that is always included in the URL.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.operation.definition",
"path": "CapabilityStatement.rest.operation.definition",
"short": "The defined operation/query",
"definition": "Where the formal definition can be found.",
"comments": "This can be used to build an HTML form to invoke the operation, for instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.compartment",
"path": "CapabilityStatement.rest.compartment",
"short": "Compartments served/used by system",
"definition": "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 it's canonical URL.",
"comments": "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CapabilityStatement.messaging",
"path": "CapabilityStatement.messaging",
"short": "If messaging is supported",
"definition": "A description of the messaging capabilities of the solution.",
"comments": "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.id",
"path": "CapabilityStatement.messaging.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.messaging.extension",
"path": "CapabilityStatement.messaging.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.messaging.modifierExtension",
"path": "CapabilityStatement.messaging.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.messaging.endpoint",
"path": "CapabilityStatement.messaging.endpoint",
"short": "Where messages should be sent",
"definition": "An endpoint (network accessible address) to which messages and/or replies are to be sent.",
"alias": [
"3"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "CapabilityStatement.messaging.endpoint.id",
"path": "CapabilityStatement.messaging.endpoint.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.messaging.endpoint.extension",
"path": "CapabilityStatement.messaging.endpoint.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.messaging.endpoint.modifierExtension",
"path": "CapabilityStatement.messaging.endpoint.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.messaging.endpoint.protocol",
"path": "CapabilityStatement.messaging.endpoint.protocol",
"short": "http | ftp | mllp +",
"definition": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "The protocol used for message transport.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-transport"
}
}
},
{
"id": "CapabilityStatement.messaging.endpoint.address",
"path": "CapabilityStatement.messaging.endpoint.address",
"short": "Address of end-point",
"definition": "The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CapabilityStatement.messaging.reliableCache",
"path": "CapabilityStatement.messaging.reliableCache",
"short": "Reliable Message Cache Length (min)",
"definition": "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comments": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
]
},
{
"id": "CapabilityStatement.messaging.documentation",
"path": "CapabilityStatement.messaging.documentation",
"short": "Messaging interface behavior details",
"definition": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, process for becoming an authorized messaging exchange partner.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.messaging.event",
"path": "CapabilityStatement.messaging.event",
"short": "Declare support for this event",
"definition": "A description of the solution's support for an event at this end-point.",
"comments": "The same event may be listed up to two times - once as sender and once as receiver.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.event.id",
"path": "CapabilityStatement.messaging.event.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.messaging.event.extension",
"path": "CapabilityStatement.messaging.event.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.messaging.event.modifierExtension",
"path": "CapabilityStatement.messaging.event.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.messaging.event.code",
"path": "CapabilityStatement.messaging.event.code",
"short": "Event type",
"definition": "A coded identifier of a supported messaging event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "One of the message events defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-events"
}
}
},
{
"id": "CapabilityStatement.messaging.event.category",
"path": "CapabilityStatement.messaging.event.category",
"short": "Consequence | Currency | Notification",
"definition": "The impact of the content of the message.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The impact of the content of a message.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-significance-category"
}
}
},
{
"id": "CapabilityStatement.messaging.event.mode",
"path": "CapabilityStatement.messaging.event.mode",
"short": "sender | receiver",
"definition": "The mode of this event declaration - whether application is sender or receiver.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The mode of a message capability statement.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-capability-mode"
}
}
},
{
"id": "CapabilityStatement.messaging.event.focus",
"path": "CapabilityStatement.messaging.event.focus",
"short": "Resource that's focus of message",
"definition": "A resource associated with the event. This is the resource that defines the event.",
"comments": "This SHALL be provided if the event type supports multiple different resource types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "CapabilityStatement.messaging.event.request",
"path": "CapabilityStatement.messaging.event.request",
"short": "Profile that describes the request",
"definition": "Information about the request for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.event.response",
"path": "CapabilityStatement.messaging.event.response",
"short": "Profile that describes the response",
"definition": "Information about the response for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.event.documentation",
"path": "CapabilityStatement.messaging.event.documentation",
"short": "Endpoint-specific event documentation",
"definition": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.document",
"path": "CapabilityStatement.document",
"short": "Document definition",
"definition": "A document definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.document.id",
"path": "CapabilityStatement.document.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.document.extension",
"path": "CapabilityStatement.document.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CapabilityStatement.document.modifierExtension",
"path": "CapabilityStatement.document.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CapabilityStatement.document.mode",
"path": "CapabilityStatement.document.mode",
"short": "producer | consumer",
"definition": "Mode of this document declaration - whether application is producer or consumer.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Whether the application produces or consumes documents.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-mode"
}
}
},
{
"id": "CapabilityStatement.document.documentation",
"path": "CapabilityStatement.document.documentation",
"short": "Description of document support",
"definition": "A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.document.profile",
"path": "CapabilityStatement.document.profile",
"short": "Constraint on a resource used in the document",
"definition": "A constraint on a resource used in the document.",
"comments": "The first resource is the document resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "CapabilityStatement",
"path": "CapabilityStatement",
"short": "A statement of system Capabilities",
"definition": "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.",
"min": 1,
"max": "1",
"constraint": [
{
"key": "cpb-8",
"severity": "error",
"human": "There can only be one REST declaration per mode",
"expression": "rest.select(mode).isDistinct()",
"xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"
},
{
"key": "cpb-7",
"severity": "error",
"human": "The set of documents must be unique by the combination of profile & mode",
"expression": "document.select(profile.reference&mode).isDistinct()",
"xpath": "count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value))"
},
{
"key": "cpb-15",
"severity": "error",
"human": "Capability Statements of kind 'instance' do not have implementation elements",
"expression": "implementation.empty() or kind != 'capability'",
"xpath": "not(exists(f:implementation)) or (f:kind/@value != 'capability')"
},
{
"key": "cpb-3",
"severity": "error",
"human": "Messaging end-point is required (and is only permitted) when statement is for an implementation",
"expression": "messaging.endpoint.empty() or kind = 'instance'",
"xpath": "not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance'"
},
{
"key": "cpb-14",
"severity": "error",
"human": "Capability Statements of kind 'requirements' do not have software or implementation elements",
"expression": "(software.empty() and implementation.empty()) or kind != 'requirements'",
"xpath": "not(exists(f:software) or exists(f:implementation)) or (f:kind/@value != 'requirements')"
},
{
"key": "cpb-2",
"severity": "error",
"human": "A Capability Statement SHALL have at least one of description, software, or implementation",
"expression": "(description.count() + software.count() + implementation.count()) > 0",
"xpath": "count(f:software | f:implementation | f:description) > 0"
},
{
"key": "cpb-1",
"severity": "error",
"human": "A Capability Statement SHALL have at least one of REST, messaging or document",
"expression": "rest.exists() or messaging.exists() or document.exists()",
"xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)"
}
],
"mapping": [
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"id": "CapabilityStatement.url",
"path": "CapabilityStatement.url",
"short": "Logical uri to reference this capability statement (globally unique)",
"definition": "An absolute URL 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).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the capability statement to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "CapabilityStatement.version",
"path": "CapabilityStatement.version",
"short": "Business version of the capability statement",
"definition": "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 are orderable.",
"comments": "There may be multiple different instances of a capability statement that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "CapabilityStatement.name",
"path": "CapabilityStatement.name",
"short": "Name for this capability statement (Computer friendly)",
"definition": "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.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.title",
"path": "CapabilityStatement.title",
"short": "Name for this capability statement (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the capability statement.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.status",
"path": "CapabilityStatement.status",
"short": "draft | active | retired",
"definition": "The status of this capability statement. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of capability statement that are appropriate for use vs. not. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CapabilityStatement.experimental",
"path": "CapabilityStatement.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag 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.",
"comments": "Allows filtering of capability statement that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level capability statement would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "CapabilityStatement.date",
"path": "CapabilityStatement.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the capability statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "CapabilityStatement.publisher",
"path": "CapabilityStatement.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the capability statement.",
"comments": "Usually an organization, but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the capability statement. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "CapabilityStatement.contact",
"path": "CapabilityStatement.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.description",
"path": "CapabilityStatement.description",
"short": "Natural language description of the capability statement",
"definition": "A free text natural language description of the capability statement from the 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.",
"comments": "This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"condition": [
"cpb-2"
]
},
{
"id": "CapabilityStatement.useContext",
"path": "CapabilityStatement.useContext",
"short": "Content intends to support these contexts",
"definition": "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 of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.jurisdiction",
"path": "CapabilityStatement.jurisdiction",
"short": "Intended jurisdiction for capability statement (if applicable)",
"definition": "A jurisdiction in which the capability statement is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "CapabilityStatement.purpose",
"path": "CapabilityStatement.purpose",
"short": "Why this capability statement is defined",
"definition": "Explains why this capability statement is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the capability statement (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CapabilityStatement.copyright",
"path": "CapabilityStatement.copyright",
"short": "Use and/or publishing restrictions",
"definition": "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.",
"requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the capability statement and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "CapabilityStatement.kind",
"path": "CapabilityStatement.kind",
"short": "instance | capability | requirements",
"definition": "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).",
"requirements": "Allow searching the 3 modes.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "How a capability statement is intended to be used.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/capability-statement-kind"
}
}
},
{
"id": "CapabilityStatement.instantiates",
"path": "CapabilityStatement.instantiates",
"short": "Canonical URL of another capability statement this implements",
"definition": "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.",
"comments": "HL7 defines the following Services: [Terminology Service](terminology-service.html)\n\nMany [Implementation Guides](https://registry.fhir.org/guides) define additional services.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software",
"path": "CapabilityStatement.software",
"short": "Software that is covered by this capability statement",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-2"
],
"isSummary": true
},
{
"id": "CapabilityStatement.software.name",
"path": "CapabilityStatement.software.name",
"short": "A name the software is known by",
"definition": "Name software is known by.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software.version",
"path": "CapabilityStatement.software.version",
"short": "Version covered by this statement",
"definition": "The version identifier for the software covered by this statement.",
"comments": "If possible, version should be specified, as statements are likely to be different for different versions of software.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.software.releaseDate",
"path": "CapabilityStatement.software.releaseDate",
"short": "Date this version released",
"definition": "Date this version of the software released.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.implementation",
"path": "CapabilityStatement.implementation",
"short": "If this describes a specific instance",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-2"
],
"isSummary": true
},
{
"id": "CapabilityStatement.implementation.description",
"path": "CapabilityStatement.implementation.description",
"short": "Describes this specific instance",
"definition": "Information about the specific installation that this capability statement relates to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.implementation.url",
"path": "CapabilityStatement.implementation.url",
"short": "Base URL for the installation",
"definition": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.fhirVersion",
"path": "CapabilityStatement.fhirVersion",
"short": "FHIR Version the system uses",
"definition": "The version of the FHIR specification on which this capability statement is based.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.acceptUnknown",
"path": "CapabilityStatement.acceptUnknown",
"short": "no | extensions | elements | both",
"definition": "A code that indicates whether the application accepts unknown elements or extensions when reading resources.",
"comments": "Unknown elements in a resource can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence accepting unknown elements is about inter-version compatibility.\n\nApplications are recommended to accept unknown extensions and elements ('both'), but this is not always possible.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "A code that indicates whether an application accepts unknown elements or extensions when reading resources.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/unknown-content-code"
}
}
},
{
"id": "CapabilityStatement.format",
"path": "CapabilityStatement.format",
"short": "formats supported (xml | json | ttl | mime type)",
"definition": "A list of the formats supported by this implementation using their content types.",
"comments": "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "CapabilityStatement.patchFormat",
"path": "CapabilityStatement.patchFormat",
"short": "Patch formats supported",
"definition": "A list of the patch formats supported by this implementation using their content types.",
"comments": "At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats matching the formats it supports, but this is not always possible or necessary.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "CapabilityStatement.implementationGuide",
"path": "CapabilityStatement.implementationGuide",
"short": "Implementation Guide supported",
"definition": "A list of implementation guides that the server does (or should) support in their entirety.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.profile",
"path": "CapabilityStatement.profile",
"short": "Profiles for use cases supported",
"definition": "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).",
"comments": "Supported profiles are different to the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). Typical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However, they do not need to describe more than one resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest",
"path": "CapabilityStatement.rest",
"short": "If the endpoint is a RESTful one",
"definition": "A definition of the restful capabilities of the solution, if any.",
"comments": "Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-1"
],
"constraint": [
{
"key": "cpb-9",
"severity": "error",
"human": "A given resource can only be described once per RESTful mode",
"expression": "resource.select(type).isDistinct()",
"xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.mode",
"path": "CapabilityStatement.rest.mode",
"short": "client | server",
"definition": "Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The mode of a RESTful capability statement.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/restful-capability-mode"
}
}
},
{
"id": "CapabilityStatement.rest.documentation",
"path": "CapabilityStatement.rest.documentation",
"short": "General description of implementation",
"definition": "Information about the system's restful capabilities that apply across all applications, such as security.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.security",
"path": "CapabilityStatement.rest.security",
"short": "Information about security of implementation",
"definition": "Information about security implementation from an interface perspective - what a client needs to know.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.security.cors",
"path": "CapabilityStatement.rest.security.cors",
"short": "Adds CORS Headers (http://enable-cors.org/)",
"definition": "Server adds CORS headers when responding to requests - this enables javascript applications to use the server.",
"comments": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.security.service",
"path": "CapabilityStatement.rest.security.service",
"short": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates",
"definition": "Types of security services are supported/required by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Types of security services used with FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/restful-security-service"
}
}
},
{
"id": "CapabilityStatement.rest.security.description",
"path": "CapabilityStatement.rest.security.description",
"short": "General description of how security works",
"definition": "General description of how security works.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate",
"path": "CapabilityStatement.rest.security.certificate",
"short": "Certificates associated with security profiles",
"definition": "Certificates associated with security profiles.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CapabilityStatement.rest.security.certificate.type",
"path": "CapabilityStatement.rest.security.certificate.type",
"short": "Mime type for certificate",
"definition": "Mime type for certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "CapabilityStatement.rest.security.certificate.blob",
"path": "CapabilityStatement.rest.security.certificate.blob",
"short": "Actual certificate",
"definition": "Actual certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"id": "CapabilityStatement.rest.resource",
"path": "CapabilityStatement.rest.resource",
"short": "Resource served on the REST interface",
"definition": "A specification of the restful capabilities of the solution for a specific resource type.",
"comments": "Max of one repetition per resource type.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "cpb-12",
"severity": "error",
"human": "Search parameter names must be unique in the context of a resource",
"expression": "searchParam.select(name).isDistinct()",
"xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.resource.type",
"path": "CapabilityStatement.rest.resource.type",
"short": "A resource type that is supported",
"definition": "A type of resource exposed via the restful interface.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "CapabilityStatement.rest.resource.profile",
"path": "CapabilityStatement.rest.resource.profile",
"short": "Base System profile for all uses of resource",
"definition": "A specification of the profile that describes the solution's 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}.",
"comments": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.resource.documentation",
"path": "CapabilityStatement.rest.resource.documentation",
"short": "Additional information about the use of the resource type",
"definition": "Additional information about the resource type is used by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ResourceInteraction"
}
],
"path": "CapabilityStatement.rest.resource.interaction",
"short": "What operations are supported?",
"definition": "Identifies a restful operation supported by the solution.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CapabilityStatement.rest.resource.interaction.code",
"path": "CapabilityStatement.rest.resource.interaction.code",
"short": "read | vread | update | patch | delete | history-instance | history-type | create | search-type",
"definition": "Coded identifier of the operation, supported by the system resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Operations supported by REST at the type or instance level.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/type-restful-interaction"
}
}
},
{
"id": "CapabilityStatement.rest.resource.interaction.documentation",
"path": "CapabilityStatement.rest.resource.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"requirements": "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.versioning",
"path": "CapabilityStatement.rest.resource.versioning",
"short": "no-version | versioned | versioned-update",
"definition": "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 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.",
"comments": "If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "How the system supports versioning for a resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/versioning-policy"
}
}
},
{
"id": "CapabilityStatement.rest.resource.readHistory",
"path": "CapabilityStatement.rest.resource.readHistory",
"short": "Whether vRead can return past versions",
"definition": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comments": "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.updateCreate",
"path": "CapabilityStatement.rest.resource.updateCreate",
"short": "If update can commit to a new identity",
"definition": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. 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.",
"comments": "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.conditionalCreate",
"path": "CapabilityStatement.rest.resource.conditionalCreate",
"short": "If allows/uses conditional create",
"definition": "A flag that indicates that the server supports conditional create.",
"comments": "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.conditionalRead",
"path": "CapabilityStatement.rest.resource.conditionalRead",
"short": "not-supported | modified-since | not-match | full-support",
"definition": "A code that indicates how the server supports conditional read.",
"comments": "Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A code that indicates how the server supports conditional read.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conditional-read-status"
}
}
},
{
"id": "CapabilityStatement.rest.resource.conditionalUpdate",
"path": "CapabilityStatement.rest.resource.conditionalUpdate",
"short": "If allows/uses conditional update",
"definition": "A flag that indicates that the server supports conditional update.",
"comments": "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CapabilityStatement.rest.resource.conditionalDelete",
"path": "CapabilityStatement.rest.resource.conditionalDelete",
"short": "not-supported | single | multiple - how conditional delete is supported",
"definition": "A code that indicates how the server supports conditional delete.",
"comments": "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A code that indicates how the server supports conditional delete.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conditional-delete-status"
}
}
},
{
"id": "CapabilityStatement.rest.resource.referencePolicy",
"path": "CapabilityStatement.rest.resource.referencePolicy",
"short": "literal | logical | resolves | enforced | local",
"definition": "A set of flags that defines how references are supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A set of flags that defines how references are supported",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reference-handling-policy"
}
}
},
{
"id": "CapabilityStatement.rest.resource.searchInclude",
"path": "CapabilityStatement.rest.resource.searchInclude",
"short": "_include values supported by the server",
"definition": "A list of _include values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchRevInclude",
"path": "CapabilityStatement.rest.resource.searchRevInclude",
"short": "_revinclude values supported by the server",
"definition": "A list of _revinclude (reverse include) values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam",
"path": "CapabilityStatement.rest.resource.searchParam",
"short": "Search params supported by implementation",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.name",
"path": "CapabilityStatement.rest.resource.searchParam.name",
"short": "Name of search parameter",
"definition": "The name of the search parameter used in the interface.",
"comments": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.definition",
"path": "CapabilityStatement.rest.resource.searchParam.definition",
"short": "Source of definition for parameter",
"definition": "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]()).",
"comments": "This SHOULD be present, and matches refers to a SearchParameter by it's canonical url. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CapabilityStatement.rest.resource.searchParam.type",
"path": "CapabilityStatement.rest.resource.searchParam.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"comments": "While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-param-type"
}
}
},
{
"id": "CapabilityStatement.rest.resource.searchParam.documentation",
"path": "CapabilityStatement.rest.resource.searchParam.documentation",
"short": "Server-specific usage",
"definition": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.interaction",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SystemInteraction"
}
],
"path": "CapabilityStatement.rest.interaction",
"short": "What operations are supported?",
"definition": "A specification of restful operations supported by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CapabilityStatement.rest.interaction.code",
"path": "CapabilityStatement.rest.interaction.code",
"short": "transaction | batch | search-system | history-system",
"definition": "A coded identifier of the operation, supported by the system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Operations supported by REST at the system level.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/system-restful-interaction"
}
}
},
{
"id": "CapabilityStatement.rest.interaction.documentation",
"path": "CapabilityStatement.rest.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.searchParam",
"path": "CapabilityStatement.rest.searchParam",
"short": "Search params for searching all resources",
"definition": "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.",
"comments": "Typically, the only search parameters supported for all parameters are search parameters that apply to all resources - tags, profiles, text search etc.",
"min": 0,
"max": "*",
"contentReference": "#CapabilityStatement.rest.resource.searchParam"
},
{
"id": "CapabilityStatement.rest.operation",
"path": "CapabilityStatement.rest.operation",
"short": "Definition of an operation or a custom query",
"definition": "Definition of an operation or a named query and with its parameters and their meaning and type.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.operation.name",
"path": "CapabilityStatement.rest.operation.name",
"short": "Name by which the operation/query is invoked",
"definition": "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.",
"comments": "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the \"$\" portion that is always included in the URL.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.rest.operation.definition",
"path": "CapabilityStatement.rest.operation.definition",
"short": "The defined operation/query",
"definition": "Where the formal definition can be found.",
"comments": "This can be used to build an HTML form to invoke the operation, for instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.rest.compartment",
"path": "CapabilityStatement.rest.compartment",
"short": "Compartments served/used by system",
"definition": "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 it's canonical URL.",
"comments": "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CapabilityStatement.messaging",
"path": "CapabilityStatement.messaging",
"short": "If messaging is supported",
"definition": "A description of the messaging capabilities of the solution.",
"comments": "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-1"
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.endpoint",
"path": "CapabilityStatement.messaging.endpoint",
"short": "Where messages should be sent",
"definition": "An endpoint (network accessible address) to which messages and/or replies are to be sent.",
"alias": [
"3"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CapabilityStatement.messaging.endpoint.protocol",
"path": "CapabilityStatement.messaging.endpoint.protocol",
"short": "http | ftp | mllp +",
"definition": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "The protocol used for message transport.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-transport"
}
}
},
{
"id": "CapabilityStatement.messaging.endpoint.address",
"path": "CapabilityStatement.messaging.endpoint.address",
"short": "Address of end-point",
"definition": "The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CapabilityStatement.messaging.reliableCache",
"path": "CapabilityStatement.messaging.reliableCache",
"short": "Reliable Message Cache Length (min)",
"definition": "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comments": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
]
},
{
"id": "CapabilityStatement.messaging.documentation",
"path": "CapabilityStatement.messaging.documentation",
"short": "Messaging interface behavior details",
"definition": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, process for becoming an authorized messaging exchange partner.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.messaging.event",
"path": "CapabilityStatement.messaging.event",
"short": "Declare support for this event",
"definition": "A description of the solution's support for an event at this end-point.",
"comments": "The same event may be listed up to two times - once as sender and once as receiver.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.event.code",
"path": "CapabilityStatement.messaging.event.code",
"short": "Event type",
"definition": "A coded identifier of a supported messaging event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "One of the message events defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-events"
}
}
},
{
"id": "CapabilityStatement.messaging.event.category",
"path": "CapabilityStatement.messaging.event.category",
"short": "Consequence | Currency | Notification",
"definition": "The impact of the content of the message.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The impact of the content of a message.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-significance-category"
}
}
},
{
"id": "CapabilityStatement.messaging.event.mode",
"path": "CapabilityStatement.messaging.event.mode",
"short": "sender | receiver",
"definition": "The mode of this event declaration - whether application is sender or receiver.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The mode of a message capability statement.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-capability-mode"
}
}
},
{
"id": "CapabilityStatement.messaging.event.focus",
"path": "CapabilityStatement.messaging.event.focus",
"short": "Resource that's focus of message",
"definition": "A resource associated with the event. This is the resource that defines the event.",
"comments": "This SHALL be provided if the event type supports multiple different resource types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "CapabilityStatement.messaging.event.request",
"path": "CapabilityStatement.messaging.event.request",
"short": "Profile that describes the request",
"definition": "Information about the request for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.event.response",
"path": "CapabilityStatement.messaging.event.response",
"short": "Profile that describes the response",
"definition": "Information about the response for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"id": "CapabilityStatement.messaging.event.documentation",
"path": "CapabilityStatement.messaging.event.documentation",
"short": "Endpoint-specific event documentation",
"definition": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.document",
"path": "CapabilityStatement.document",
"short": "Document definition",
"definition": "A document definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpb-1"
],
"isSummary": true
},
{
"id": "CapabilityStatement.document.mode",
"path": "CapabilityStatement.document.mode",
"short": "producer | consumer",
"definition": "Mode of this document declaration - whether application is producer or consumer.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Whether the application produces or consumes documents.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-mode"
}
}
},
{
"id": "CapabilityStatement.document.documentation",
"path": "CapabilityStatement.document.documentation",
"short": "Description of document support",
"definition": "A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CapabilityStatement.document.profile",
"path": "CapabilityStatement.document.profile",
"short": "Constraint on a resource used in the document",
"definition": "A constraint on a resource used in the document.",
"comments": "The first resource is the document resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change