Release 5 Preview #1
ConformanceThis page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for capabilitystatement2
{
"resourceType" : "StructureDefinition",
"id" : "CapabilityStatement2",
"meta" : {
"lastUpdated" : "2019-12-31T21:03:40.621+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CapabilityStatement2",
"version" : "4.2.0",
"name" : "CapabilityStatement2",
"status" : "draft",
"date" : "2019-12-31T21:03:40+11:00",
"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"
}]
}],
"description" : "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"fhirVersion" : "4.2.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CapabilityStatement2",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CanonicalResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CapabilityStatement2",
"path" : "CapabilityStatement2",
"short" : "A statement of system capabilities",
"definition" : "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"comment" : "Applications may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement2-operation-versions.html) operation). If they do, then a CapabilityStatement2 describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "cnl-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "cp2-1",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of REST, messaging or document element.",
"expression" : "rest.exists()",
"xpath" : "exists(f:rest)"
},
{
"key" : "cp2-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "cp2-14",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "cp2-15",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
},
{
"key" : "cp2-16",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.id",
"path" : "CapabilityStatement2.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.",
"comment" : "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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.meta",
"path" : "CapabilityStatement2.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 might 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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implicitRules",
"path" : "CapabilityStatement2.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CapabilityStatement2.language",
"path" : "CapabilityStatement2.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CapabilityStatement2.text",
"path" : "CapabilityStatement2.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "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 information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CapabilityStatement2.contained",
"path" : "CapabilityStatement2.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.",
"comment" : "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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.modifierExtension",
"path" : "CapabilityStatement2.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.url",
"path" : "CapabilityStatement2.url",
"short" : "Canonical identifier for this capability statement2, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this capability statement2 when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement2 is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement2 is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the capability statement2 to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CapabilityStatement2.version",
"path" : "CapabilityStatement2.version",
"short" : "Business version of the capability statement2",
"definition" : "The identifier that is used to identify this version of the capability statement2 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement2 author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different capability statement2 instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement2 with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CapabilityStatement2.name",
"path" : "CapabilityStatement2.name",
"short" : "Name for this capability statement2 (computer friendly)",
"definition" : "A natural language name identifying the capability statement2. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["cnl-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.title",
"path" : "CapabilityStatement2.title",
"short" : "Name for this capability statement2 (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the capability statement2.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "CapabilityStatement2.status",
"path" : "CapabilityStatement2.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this capability statement2. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of capability statement2s that are appropriate for use versus 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",
"base" : {
"path" : "CapabilityStatement2.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.2.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CapabilityStatement2.experimental",
"path" : "CapabilityStatement2.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this capability statement2 is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of capability statement2s that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement2.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CapabilityStatement2.date",
"path" : "CapabilityStatement2.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the capability statement2 was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement2 changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement2. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CapabilityStatement2.publisher",
"path" : "CapabilityStatement2.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the capability statement2.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the capability statement2 is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement2. 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 statement2. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the capability statement2. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CapabilityStatement2.contact",
"path" : "CapabilityStatement2.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CapabilityStatement2.description",
"path" : "CapabilityStatement2.description",
"short" : "Natural language description of the capability statement2",
"definition" : "A free text natural language description of the capability statement2 from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment" : "This description can be used to capture details such as why the capability statement2 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 capability statement2 as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement2 is presumed to be the predominant language in the place the capability statement2 was created).This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"condition" : ["cp2-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "CapabilityStatement2.useContext",
"path" : "CapabilityStatement2.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement2 instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CapabilityStatement2.jurisdiction",
"path" : "CapabilityStatement2.jurisdiction",
"short" : "Intended jurisdiction for capability statement2 (if applicable)",
"definition" : "A legal or geographic region in which the capability statement2 is intended to be used.",
"comment" : "It may be possible for the capability statement2 to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "CapabilityStatement2.purpose",
"path" : "CapabilityStatement2.purpose",
"short" : "Why this capability statement2 is defined",
"definition" : "Explanation of why this capability statement2 is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the capability statement2. Instead, it provides 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 statement2.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement2.copyright",
"path" : "CapabilityStatement2.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the capability statement2 and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement2.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the capability statement2 and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement2.kind",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["cp2-15"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatement2Kind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind|4.2.0"
}
},
{
"id" : "CapabilityStatement2.instantiates",
"path" : "CapabilityStatement2.instantiates",
"short" : "Canonical URL of another capability statement this implements",
"definition" : "Reference to a canonical URL of another CapabilityStatement2 that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.",
"comment" : "HL7 defines the following Services: [Terminology Service](terminology-service.html). \n\nMany [Implementation Guides](http://fhir.org/guides/registry) define additional services.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.instantiates",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement2"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.imports",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement2.imports",
"short" : "Canonical URL of another capability statement this adds to",
"definition" : "Reference to a canonical URL of another CapabilityStatement2 that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.",
"comment" : "the contents of any directly or indirectly imported CapabilityStatement2s SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.\n\nA capability statement that imports another CapabilityStatement2 automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatement2s that are suitable for importing).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.imports",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement2"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.software",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cp2-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software.id",
"path" : "CapabilityStatement2.software.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.software.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.software.modifierExtension",
"path" : "CapabilityStatement2.software.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.software.name",
"path" : "CapabilityStatement2.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.software.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software.version",
"path" : "CapabilityStatement2.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.software.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software.releaseDate",
"path" : "CapabilityStatement2.software.releaseDate",
"short" : "Date this version was released",
"definition" : "Date this version of the software was released.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.software.releaseDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.implementation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cp2-2",
"cp2-15"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation.id",
"path" : "CapabilityStatement2.implementation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.implementation.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.implementation.modifierExtension",
"path" : "CapabilityStatement2.implementation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.implementation.description",
"path" : "CapabilityStatement2.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this capability statement relates to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.implementation.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation.url",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.implementation.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation.custodian",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement2.implementation.custodian",
"short" : "Organization that manages the data",
"definition" : "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.implementation.custodian",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.fhirVersion",
"path" : "CapabilityStatement2.fhirVersion",
"short" : "FHIR Version the system supports",
"definition" : "The version of the FHIR specification that this CapabilityStatement2 describes (which SHALL be the same as the FHIR version of the CapabilityStatement2 itself). There is no default value.",
"comment" : "Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement2-operation-versions.html) operation). If they do, and the CapabilityStatement2 is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.fhirVersion",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRVersion"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "All published FHIR Versions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0"
}
},
{
"id" : "CapabilityStatement2.format",
"path" : "CapabilityStatement2.format",
"short" : "formats supported (xml | json | ttl | mime type)",
"definition" : "A list of the formats supported by this implementation using their content types.",
"comment" : "\"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" : "*",
"base" : {
"path" : "CapabilityStatement2.format",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.2.0"
}
},
{
"id" : "CapabilityStatement2.patchFormat",
"path" : "CapabilityStatement2.patchFormat",
"short" : "Patch formats supported",
"definition" : "A list of the patch formats supported by this implementation using their content types.",
"comment" : "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 and match the formats it supports, but this is not always possible or necessary.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.patchFormat",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.2.0"
}
},
{
"id" : "CapabilityStatement2.implementationGuide",
"path" : "CapabilityStatement2.implementationGuide",
"short" : "Implementation guides supported",
"definition" : "A list of implementation guides that the server does (or should) support in their entirety.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.implementationGuide",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest",
"path" : "CapabilityStatement2.rest",
"short" : "If the endpoint is a RESTful one",
"definition" : "A definition of the restful capabilities of the solution, if any.",
"comment" : "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" : "*",
"base" : {
"path" : "CapabilityStatement2.rest",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cp2-1"],
"constraint" : [{
"key" : "cp2-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))"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.id",
"path" : "CapabilityStatement2.rest.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.modifierExtension",
"path" : "CapabilityStatement2.rest.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.rest.mode",
"path" : "CapabilityStatement2.rest.mode",
"short" : "client | server",
"definition" : "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RestfulCapabilityMode"
}],
"strength" : "required",
"description" : "The mode of a RESTful capability statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-capability-mode|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.documentation",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.rest.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource",
"path" : "CapabilityStatement2.rest.resource",
"short" : "Resource served on the REST interface",
"definition" : "A specification of the restful capabilities of the solution for a specific resource type.",
"comment" : "Max of one repetition per resource type.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.resource",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "cp2-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))"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.id",
"path" : "CapabilityStatement2.rest.resource.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.modifierExtension",
"path" : "CapabilityStatement2.rest.resource.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.type",
"path" : "CapabilityStatement2.rest.resource.type",
"short" : "A resource type that is supported",
"definition" : "A type of resource exposed via the restful interface.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.resource.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.resource.profile",
"path" : "CapabilityStatement2.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).",
"comment" : "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",
"base" : {
"path" : "CapabilityStatement2.rest.resource.profile",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.supportedProfile",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement2.rest.resource.supportedProfile",
"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).",
"comment" : "Supported profiles are different than the profile that applies 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 do? 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).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.resource.supportedProfile",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.documentation",
"path" : "CapabilityStatement2.rest.resource.documentation",
"short" : "Additional information about the use of the resource type",
"definition" : "Additional information about the resource type used by the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.resource.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ResourceInteraction"
}],
"path" : "CapabilityStatement2.rest.resource.interaction",
"short" : "What operations are supported?",
"definition" : "Identifies a restful operation supported by the solution.",
"comment" : "In general, a Resource will only appear in a CapabilityStatement2 if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.resource.interaction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.id",
"path" : "CapabilityStatement2.rest.resource.interaction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.modifierExtension",
"path" : "CapabilityStatement2.rest.resource.interaction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.code",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.rest.resource.interaction.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TypeRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the type or instance level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/type-restful-interaction|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.documentation",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.rest.resource.interaction.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam",
"path" : "CapabilityStatement2.rest.resource.searchParam",
"short" : "Search parameters 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.",
"comment" : "The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement2.rest.searchParam](capabilitystatement2-definitions.html#CapabilityStatement2.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.resource.searchParam",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.id",
"path" : "CapabilityStatement2.rest.resource.searchParam.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.modifierExtension",
"path" : "CapabilityStatement2.rest.resource.searchParam.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.name",
"path" : "CapabilityStatement2.rest.resource.searchParam.name",
"short" : "Name of search parameter",
"definition" : "The name of the search parameter used in the interface.",
"comment" : "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.resource.searchParam.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.definition",
"path" : "CapabilityStatement2.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](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"comment" : "This SHOULD be present, and matches refers to a SearchParameter by its 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. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.resource.searchParam.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.type",
"path" : "CapabilityStatement2.rest.resource.searchParam.type",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "The type of value a search parameter refers to, and how the content is interpreted.",
"comment" : "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",
"base" : {
"path" : "CapabilityStatement2.rest.resource.searchParam.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.documentation",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.rest.resource.searchParam.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.resource.operation",
"path" : "CapabilityStatement2.rest.resource.operation",
"short" : "Definition of a resource operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.",
"comment" : "Operations linked from CapabilityStatement2.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. \n\nIf an operation that is listed in multiple CapabilityStatement2.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.resource.operation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.operation.id",
"path" : "CapabilityStatement2.rest.resource.operation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.operation.extension",
"path" : "CapabilityStatement2.rest.resource.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.operation.modifierExtension",
"path" : "CapabilityStatement2.rest.resource.operation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.operation.name",
"path" : "CapabilityStatement2.rest.resource.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.",
"comment" : "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",
"base" : {
"path" : "CapabilityStatement2.rest.resource.operation.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.operation.definition",
"path" : "CapabilityStatement2.rest.resource.operation.definition",
"short" : "The defined operation/query",
"definition" : "Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.",
"comment" : "This can be used to build an HTML form to invoke the operation, for instance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.resource.operation.definition",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.operation.documentation",
"path" : "CapabilityStatement2.rest.resource.operation.documentation",
"short" : "Specific details about operation behavior",
"definition" : "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement2.rest.resource.operation.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SystemInteraction"
}],
"path" : "CapabilityStatement2.rest.interaction",
"short" : "What operations are supported?",
"definition" : "A specification of restful operations supported by the system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.interaction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.interaction.id",
"path" : "CapabilityStatement2.rest.interaction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.interaction.extension",
"path" : "CapabilityStatement2.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.rest.interaction.modifierExtension",
"path" : "CapabilityStatement2.rest.interaction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement2.rest.interaction.code",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.rest.interaction.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SystemRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the system level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/system-restful-interaction|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.interaction.documentation",
"path" : "CapabilityStatement2.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",
"base" : {
"path" : "CapabilityStatement2.rest.interaction.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.searchParam",
"path" : "CapabilityStatement2.rest.searchParam",
"short" : "Search parameters 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.",
"comment" : "Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement2.rest.searchParam](capabilitystatement2-definitions.html#CapabilityStatement2.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.searchParam",
"min" : 0,
"max" : "*"
},
"contentReference" : "#CapabilityStatement2.rest.resource.searchParam",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement2.rest.operation",
"path" : "CapabilityStatement2.rest.operation",
"short" : "Definition of a system level operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type.",
"comment" : "CapabilityStatement2.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement2.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.operation",
"min" : 0,
"max" : "*"
},
"contentReference" : "#CapabilityStatement2.rest.resource.operation",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.compartment",
"path" : "CapabilityStatement2.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 its canonical URL .",
"comment" : "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement2.rest.compartment",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "CapabilityStatement2",
"path" : "CapabilityStatement2",
"short" : "A statement of system capabilities",
"definition" : "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"comment" : "Applications may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement2-operation-versions.html) operation). If they do, then a CapabilityStatement2 describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "cnl-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "cp2-14",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "cp2-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "cp2-16",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
},
{
"key" : "cp2-15",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
},
{
"key" : "cp2-1",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of REST, messaging or document element.",
"expression" : "rest.exists()",
"xpath" : "exists(f:rest)"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement2.url",
"path" : "CapabilityStatement2.url",
"short" : "Canonical identifier for this capability statement2, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this capability statement2 when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement2 is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement2 is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the capability statement2 to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CapabilityStatement2.version",
"path" : "CapabilityStatement2.version",
"short" : "Business version of the capability statement2",
"definition" : "The identifier that is used to identify this version of the capability statement2 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement2 author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different capability statement2 instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement2 with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CapabilityStatement2.name",
"path" : "CapabilityStatement2.name",
"short" : "Name for this capability statement2 (computer friendly)",
"definition" : "A natural language name identifying the capability statement2. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["cnl-0"],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.title",
"path" : "CapabilityStatement2.title",
"short" : "Name for this capability statement2 (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the capability statement2.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "CapabilityStatement2.status",
"path" : "CapabilityStatement2.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this capability statement2. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of capability statement2s that are appropriate for use versus 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,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.2.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CapabilityStatement2.experimental",
"path" : "CapabilityStatement2.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this capability statement2 is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of capability statement2s that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement2.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CapabilityStatement2.date",
"path" : "CapabilityStatement2.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the capability statement2 was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement2 changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement2. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CapabilityStatement2.publisher",
"path" : "CapabilityStatement2.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the capability statement2.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the capability statement2 is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement2. 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 statement2. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the capability statement2. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CapabilityStatement2.contact",
"path" : "CapabilityStatement2.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CapabilityStatement2.description",
"path" : "CapabilityStatement2.description",
"short" : "Natural language description of the capability statement2",
"definition" : "A free text natural language description of the capability statement2 from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment" : "This description can be used to capture details such as why the capability statement2 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 capability statement2 as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement2 is presumed to be the predominant language in the place the capability statement2 was created).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" : ["cp2-2"],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "CapabilityStatement2.useContext",
"path" : "CapabilityStatement2.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement2 instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CapabilityStatement2.jurisdiction",
"path" : "CapabilityStatement2.jurisdiction",
"short" : "Intended jurisdiction for capability statement2 (if applicable)",
"definition" : "A legal or geographic region in which the capability statement2 is intended to be used.",
"comment" : "It may be possible for the capability statement2 to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "CapabilityStatement2.purpose",
"path" : "CapabilityStatement2.purpose",
"short" : "Why this capability statement2 is defined",
"definition" : "Explanation of why this capability statement2 is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the capability statement2. Instead, it provides 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 statement2.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement2.copyright",
"path" : "CapabilityStatement2.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the capability statement2 and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement2.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the capability statement2 and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement2.kind",
"path" : "CapabilityStatement2.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"
}],
"condition" : ["cp2-15"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatement2Kind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind|4.2.0"
}
},
{
"id" : "CapabilityStatement2.instantiates",
"path" : "CapabilityStatement2.instantiates",
"short" : "Canonical URL of another capability statement this implements",
"definition" : "Reference to a canonical URL of another CapabilityStatement2 that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.",
"comment" : "HL7 defines the following Services: [Terminology Service](terminology-service.html). \n\nMany [Implementation Guides](http://fhir.org/guides/registry) define additional services.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement2"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.imports",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement2.imports",
"short" : "Canonical URL of another capability statement this adds to",
"definition" : "Reference to a canonical URL of another CapabilityStatement2 that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.",
"comment" : "the contents of any directly or indirectly imported CapabilityStatement2s SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.\n\nA capability statement that imports another CapabilityStatement2 automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatement2s that are suitable for importing).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement2"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software",
"path" : "CapabilityStatement2.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" : ["cp2-2"],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software.name",
"path" : "CapabilityStatement2.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.software.version",
"path" : "CapabilityStatement2.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a 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" : "CapabilityStatement2.software.releaseDate",
"path" : "CapabilityStatement2.software.releaseDate",
"short" : "Date this version was released",
"definition" : "Date this version of the software was released.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation",
"path" : "CapabilityStatement2.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" : ["cp2-2",
"cp2-15"],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation.description",
"path" : "CapabilityStatement2.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" : "CapabilityStatement2.implementation.url",
"path" : "CapabilityStatement2.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" : "url"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.implementation.custodian",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement2.implementation.custodian",
"short" : "Organization that manages the data",
"definition" : "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.fhirVersion",
"path" : "CapabilityStatement2.fhirVersion",
"short" : "FHIR Version the system supports",
"definition" : "The version of the FHIR specification that this CapabilityStatement2 describes (which SHALL be the same as the FHIR version of the CapabilityStatement2 itself). There is no default value.",
"comment" : "Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement2-operation-versions.html) operation). If they do, and the CapabilityStatement2 is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRVersion"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "All published FHIR Versions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0"
}
},
{
"id" : "CapabilityStatement2.format",
"path" : "CapabilityStatement2.format",
"short" : "formats supported (xml | json | ttl | mime type)",
"definition" : "A list of the formats supported by this implementation using their content types.",
"comment" : "\"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" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.2.0"
}
},
{
"id" : "CapabilityStatement2.patchFormat",
"path" : "CapabilityStatement2.patchFormat",
"short" : "Patch formats supported",
"definition" : "A list of the patch formats supported by this implementation using their content types.",
"comment" : "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 and match the formats it supports, but this is not always possible or necessary.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.2.0"
}
},
{
"id" : "CapabilityStatement2.implementationGuide",
"path" : "CapabilityStatement2.implementationGuide",
"short" : "Implementation guides supported",
"definition" : "A list of implementation guides that the server does (or should) support in their entirety.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest",
"path" : "CapabilityStatement2.rest",
"short" : "If the endpoint is a RESTful one",
"definition" : "A definition of the restful capabilities of the solution, if any.",
"comment" : "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" : ["cp2-1"],
"constraint" : [{
"key" : "cp2-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" : "CapabilityStatement2.rest.mode",
"path" : "CapabilityStatement2.rest.mode",
"short" : "client | server",
"definition" : "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RestfulCapabilityMode"
}],
"strength" : "required",
"description" : "The mode of a RESTful capability statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-capability-mode|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.documentation",
"path" : "CapabilityStatement2.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" : "markdown"
}]
},
{
"id" : "CapabilityStatement2.rest.resource",
"path" : "CapabilityStatement2.rest.resource",
"short" : "Resource served on the REST interface",
"definition" : "A specification of the restful capabilities of the solution for a specific resource type.",
"comment" : "Max of one repetition per resource type.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "cp2-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" : "CapabilityStatement2.rest.resource.type",
"path" : "CapabilityStatement2.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" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.resource.profile",
"path" : "CapabilityStatement2.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).",
"comment" : "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" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.supportedProfile",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement2.rest.resource.supportedProfile",
"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).",
"comment" : "Supported profiles are different than the profile that applies 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 do? 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).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.documentation",
"path" : "CapabilityStatement2.rest.resource.documentation",
"short" : "Additional information about the use of the resource type",
"definition" : "Additional information about the resource type used by the system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ResourceInteraction"
}],
"path" : "CapabilityStatement2.rest.resource.interaction",
"short" : "What operations are supported?",
"definition" : "Identifies a restful operation supported by the solution.",
"comment" : "In general, a Resource will only appear in a CapabilityStatement2 if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.code",
"path" : "CapabilityStatement2.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" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TypeRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the type or instance level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/type-restful-interaction|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.resource.interaction.documentation",
"path" : "CapabilityStatement2.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" : "markdown"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam",
"path" : "CapabilityStatement2.rest.resource.searchParam",
"short" : "Search parameters 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.",
"comment" : "The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement2.rest.searchParam](capabilitystatement2-definitions.html#CapabilityStatement2.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.name",
"path" : "CapabilityStatement2.rest.resource.searchParam.name",
"short" : "Name of search parameter",
"definition" : "The name of the search parameter used in the interface.",
"comment" : "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.definition",
"path" : "CapabilityStatement2.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](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"comment" : "This SHOULD be present, and matches refers to a SearchParameter by its 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. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}]
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.type",
"path" : "CapabilityStatement2.rest.resource.searchParam.type",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "The type of value a search parameter refers to, and how the content is interpreted.",
"comment" : "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" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.resource.searchParam.documentation",
"path" : "CapabilityStatement2.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" : "markdown"
}]
},
{
"id" : "CapabilityStatement2.rest.resource.operation",
"path" : "CapabilityStatement2.rest.resource.operation",
"short" : "Definition of a resource operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.",
"comment" : "Operations linked from CapabilityStatement2.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. \n\nIf an operation that is listed in multiple CapabilityStatement2.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.operation.name",
"path" : "CapabilityStatement2.rest.resource.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.",
"comment" : "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"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.operation.definition",
"path" : "CapabilityStatement2.rest.resource.operation.definition",
"short" : "The defined operation/query",
"definition" : "Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.",
"comment" : "This can be used to build an HTML form to invoke the operation, for instance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.resource.operation.documentation",
"path" : "CapabilityStatement2.rest.resource.operation.documentation",
"short" : "Specific details about operation behavior",
"definition" : "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement2.rest.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SystemInteraction"
}],
"path" : "CapabilityStatement2.rest.interaction",
"short" : "What operations are supported?",
"definition" : "A specification of restful operations supported by the system.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement2.rest.interaction.code",
"path" : "CapabilityStatement2.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" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SystemRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the system level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/system-restful-interaction|4.2.0"
}
},
{
"id" : "CapabilityStatement2.rest.interaction.documentation",
"path" : "CapabilityStatement2.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" : "markdown"
}]
},
{
"id" : "CapabilityStatement2.rest.searchParam",
"path" : "CapabilityStatement2.rest.searchParam",
"short" : "Search parameters 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.",
"comment" : "Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement2.rest.searchParam](capabilitystatement2-definitions.html#CapabilityStatement2.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"contentReference" : "#CapabilityStatement2.rest.resource.searchParam"
},
{
"id" : "CapabilityStatement2.rest.operation",
"path" : "CapabilityStatement2.rest.operation",
"short" : "Definition of a system level operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type.",
"comment" : "CapabilityStatement2.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement2.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.",
"min" : 0,
"max" : "*",
"contentReference" : "#CapabilityStatement2.rest.resource.operation",
"isSummary" : true
},
{
"id" : "CapabilityStatement2.rest.compartment",
"path" : "CapabilityStatement2.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 its canonical URL .",
"comment" : "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"]
}]
}]
}
}
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.
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.2.0 (GitHub f996518d66) generated on Tue, Dec 31, 2019 21:08+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change