Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_CapabilityStatement_R3

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-CapabilityStatement Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_CapabilityStatement_R3

This cross-version profile allows R5 CapabilityStatement content to be represented via FHIR STU3 CapabilityStatement resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CapabilityStatement C 1..1 CapabilityStatement A statement of system capabilities
Constraints: cpb-8, cpb-7, cpb-15, cpb-3, cpb-14, cpb-2, cpb-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the CapabilityStatement (business identifier) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:imports 0..* uri R5: Canonical URL of another capability statement this adds to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.imports
.... extension:acceptLanguage 0..* code R5: Languages supported (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.acceptLanguage
.... extension:supportedProfile 0..* uri R5: Use-case specific profiles additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.supportedProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... kind Σ 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
... fhirVersion Σ 1..1 id FHIR Version the system uses
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:fhirVersion 0..1 code R5: FHIR Version the system supports additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.fhirVersion
Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions.
... acceptUnknown Σ 1..1 code no | extensions | elements | both
Binding: UnknownContentCode (required): A code that indicates whether an application accepts unknown elements or extensions when reading resources.
... format Σ 1..* code formats supported (xml | json | ttl | mime type)
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CapabilityStatement.​status Base required PublicationStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​kind Base required CapabilityStatementKind 📍3.0.2 FHIR Std.
CapabilityStatement.​acceptUnknown Base required UnknownContentCode 📍3.0.2 FHIR Std.
CapabilityStatement.​format Base required ​ null (missing link) 📦 unknown?

Constraints

Id Grade Path(s) Description Expression
cpb-1 error CapabilityStatement A Capability Statement SHALL have at least one of REST, messaging or document element. rest.exists() or messaging.exists() or document.exists()
cpb-2 error CapabilityStatement A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
cpb-3 error CapabilityStatement Messaging end-point is required (and is only permitted) when a statement is for an implementation. messaging.endpoint.empty() or kind = 'instance'
cpb-7 error CapabilityStatement The set of documents must be unique by the combination of profile and mode. document.select(profile.reference&mode).isDistinct()
cpb-8 error CapabilityStatement There can only be one REST declaration per mode. rest.select(mode).isDistinct()
cpb-14 error CapabilityStatement Capability Statements of kind 'requirements' do not have software or implementation elements. (software.empty() and implementation.empty()) or kind != 'requirements'
cpb-15 error CapabilityStatement Capability Statements of kind 'instance' do not have implementation elements. implementation.empty() or kind != 'capability'
dom-1 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CapabilityStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CapabilityStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CapabilityStatement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CapabilityStatement 1..1 CapabilityStatement A statement of system capabilities
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the CapabilityStatement (business identifier) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:imports 0..* uri R5: Canonical URL of another capability statement this adds to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.imports
.... extension:acceptLanguage 0..* code R5: Languages supported (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.acceptLanguage
.... extension:supportedProfile 0..* uri R5: Use-case specific profiles additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.supportedProfile
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.contact
... implementation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 Reference(Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Organization that manages the data (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.implementation.custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:fhirVersion 0..1 code R5: FHIR Version the system supports additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.fhirVersion
Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions.
... rest
.... resource
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conditionalPatch 0..1 boolean R5: If allows/uses conditional patch (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.conditionalPatch
..... type
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 0..1 code R5: type additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.type
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
..... profile
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:profile 0..1 uri R5: System-wide profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.profile
..... searchParam
...... type
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:type 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.searchParam.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... operation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:documentation 0..1 markdown R5: Specific details about operation behavior (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.documentation
..... definition
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 0..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.definition
... messaging
.... supportedMessage
..... definition
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 0..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.messaging.supportedMessage.definition
... document
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 0..1 uri R5: Constraint on the resources used in the document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.document.profile

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CapabilityStatement C 1..1 CapabilityStatement A statement of system capabilities
Constraints: cpb-8, cpb-7, cpb-15, cpb-3, cpb-14, cpb-2, cpb-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the CapabilityStatement (business identifier) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:imports 0..* uri R5: Canonical URL of another capability statement this adds to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.imports
.... extension:acceptLanguage 0..* code R5: Languages supported (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.acceptLanguage
.... extension:supportedProfile 0..* uri R5: Use-case specific profiles additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.supportedProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this capability statement (globally unique)
... version Σ 0..1 string Business version of the capability statement
... name Σ 0..1 string Name for this capability statement (computer friendly)
... title Σ 0..1 string Name for this capability statement (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... description C 0..1 markdown Natural language description of the capability statement
... useContext Σ 0..* UsageContext Context the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
... purpose 0..1 markdown Why this capability statement is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... kind Σ 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
... instantiates Σ 0..* uri Canonical URL of another capability statement this implements
... software ΣC 0..1 BackboneElement Software that is covered by this capability statement
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... name Σ 1..1 string A name the software is known by
.... version Σ 0..1 string Version covered by this statement
.... releaseDate Σ 0..1 dateTime Date this version released
... implementation ΣC 0..1 BackboneElement If this describes a specific instance
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 Reference(Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Organization that manages the data (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.implementation.custodian
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... description Σ 1..1 string Describes this specific instance
.... url Σ 0..1 uri Base URL for the installation
... fhirVersion Σ 1..1 id FHIR Version the system uses
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:fhirVersion 0..1 code R5: FHIR Version the system supports additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.fhirVersion
Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions.
.... value 0..1 string Primitive value for id
... acceptUnknown Σ 1..1 code no | extensions | elements | both
Binding: UnknownContentCode (required): A code that indicates whether an application accepts unknown elements or extensions when reading resources.
... format Σ 1..* code formats supported (xml | json | ttl | mime type)
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.
... patchFormat Σ 0..* code Patch formats supported
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.
... implementationGuide Σ 0..* uri Implementation guides supported
... profile Σ 0..* Reference(StructureDefinition) Profiles for use cases supported
... rest ΣC 0..* BackboneElement If the endpoint is a RESTful one
Constraints: cpb-9
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... mode Σ 1..1 code client | server
Binding: RestfulCapabilityMode (required): The mode of a RESTful capability statement.
.... documentation 0..1 string General description of implementation
.... security Σ 0..1 BackboneElement Information about security of implementation
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... cors Σ 0..1 boolean Adds CORS Headers (http://enable-cors.org/)
..... service Σ 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Binding: RestfulSecurityService (extensible): Types of security services used with FHIR.
..... description 0..1 string General description of how security works
..... certificate 0..* BackboneElement Certificates associated with security profiles
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
...... type 0..1 code Mime type for certificates
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.
...... blob 0..1 base64Binary Actual certificate
.... resource ΣC 0..* BackboneElement Resource served on the REST interface
Constraints: cpb-12
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conditionalPatch 0..1 boolean R5: If allows/uses conditional patch (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.conditionalPatch
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... type Σ 1..1 code A resource type that is supported
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 0..1 code R5: type additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.type
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
...... value 0..1 code Primitive value for code
..... profile Σ 0..1 Reference(StructureDefinition) Base System profile for all uses of resource
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:profile 0..1 uri R5: System-wide profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.profile
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... documentation 0..1 markdown Additional information about the use of the resource type
..... interaction 1..* BackboneElement What operations are supported?
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
...... code 1..1 code read | vread | update | patch | delete | history-instance | history-type | create | search-type
Binding: TypeRestfulInteraction (required): Operations supported by REST at the type or instance level.
...... documentation 0..1 string Anything special about operation behavior
..... versioning 0..1 code no-version | versioned | versioned-update
Binding: ResourceVersionPolicy (required): How the system supports versioning for a resource.
..... readHistory 0..1 boolean Whether vRead can return past versions
..... updateCreate 0..1 boolean If update can commit to a new identity
..... conditionalCreate 0..1 boolean If allows/uses conditional create
..... conditionalRead 0..1 code not-supported | modified-since | not-match | full-support
Binding: ConditionalReadStatus (required): A code that indicates how the server supports conditional read.
..... conditionalUpdate 0..1 boolean If allows/uses conditional update
..... conditionalDelete 0..1 code not-supported | single | multiple - how conditional delete is supported
Binding: ConditionalDeleteStatus (required): A code that indicates how the server supports conditional delete.
..... referencePolicy 0..* code literal | logical | resolves | enforced | local
Binding: ReferenceHandlingPolicy (required): A set of flags that defines how references are supported.
..... searchInclude 0..* string _include values supported by the server
..... searchRevInclude 0..* string _revinclude values supported by the server
..... searchParam 0..* BackboneElement Search parameters supported by implementation
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
...... name 1..1 string Name of search parameter
...... definition 0..1 uri Source of definition for parameter
...... type 1..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:type 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.searchParam.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
....... value 0..1 code Primitive value for code
...... documentation 0..1 string Server-specific usage
.... interaction 0..* BackboneElement What operations are supported?
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code 1..1 code transaction | batch | search-system | history-system
Binding: SystemRestfulInteraction (required): Operations supported by REST at the system level.
..... documentation 0..1 string Anything special about operation behavior
.... searchParam 0..* See searchParam (CapabilityStatement) Search parameters for searching all resources
.... operation Σ 0..* BackboneElement Definition of an operation or a custom query
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:documentation 0..1 markdown R5: Specific details about operation behavior (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.documentation
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... name 1..1 string Name by which the operation/query is invoked
..... definition Σ 1..1 Reference(OperationDefinition) The defined operation/query
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 1..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.definition
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... compartment 0..* uri Compartments served/used by system
... messaging ΣC 0..* BackboneElement If messaging is supported
Constraints: cpb-16
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... endpoint 0..* BackboneElement Where messages should be sent
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... protocol 1..1 Coding http | ftp | mllp +
Binding: MessageTransport (extensible): The protocol used for message transport.
..... address 1..1 uri Network address or identifier of the end-point
.... reliableCache 0..1 unsignedInt Reliable Message Cache Length (min)
.... documentation 0..1 string Messaging interface behavior details
.... supportedMessage Σ 0..* BackboneElement Messages supported by this system
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... mode Σ 1..1 code sender | receiver
Binding: EventCapabilityMode (required): The mode of a message capability statement.
..... definition Σ 1..1 Reference(MessageDefinition) Message supported by this system
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 1..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.messaging.supportedMessage.definition
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... event Σ 0..* BackboneElement Declare support for this event
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 Coding Event type
Binding: MessageEvent (example): One of the message events defined as part of FHIR.
..... category 0..1 code Consequence | Currency | Notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.
..... mode 1..1 code sender | receiver
Binding: EventCapabilityMode (required): The mode of a message capability statement.
..... focus 1..1 code Resource that's focus of message
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
..... request Σ 1..1 Reference(StructureDefinition) Profile that describes the request
..... response Σ 1..1 Reference(StructureDefinition) Profile that describes the response
..... documentation 0..1 string Endpoint-specific event documentation
... document ΣC 0..* BackboneElement Document definition
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... mode 1..1 code producer | consumer
Binding: DocumentMode (required): Whether the application produces or consumes documents.
.... documentation 0..1 string Description of document support
.... profile Σ 1..1 Reference(StructureDefinition) Constraint on a resource used in the document
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 1..1 uri R5: Constraint on the resources used in the document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.document.profile
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CapabilityStatement.​language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
CapabilityStatement.​status Base required PublicationStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
CapabilityStatement.​kind Base required CapabilityStatementKind 📍3.0.2 FHIR Std.
CapabilityStatement.​acceptUnknown Base required UnknownContentCode 📍3.0.2 FHIR Std.
CapabilityStatement.​format Base required ​ null (missing link) 📦 unknown?
CapabilityStatement.​patchFormat Base required ​ null (missing link) 📦 unknown?
CapabilityStatement.​rest.mode Base required RestfulCapabilityMode 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.security.service Base extensible RestfulSecurityService 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.security.certificate.​type Base required ​ null (missing link) 📦 unknown?
CapabilityStatement.​rest.resource.type Base required ResourceType . 📍3.0.2 tx.fhir.org
CapabilityStatement.​rest.resource.interaction.​code Base required TypeRestfulInteraction 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.versioning Base required ResourceVersionPolicy 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.conditionalRead Base required ConditionalReadStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.conditionalDelete Base required ConditionalDeleteStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.referencePolicy Base required ReferenceHandlingPolicy 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.searchParam.​type Base required SearchParamType 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.interaction.code Base required SystemRestfulInteraction 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.endpoint.protocol Base extensible MessageTransport 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.supportedMessage.​mode Base required EventCapabilityMode 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.code Base example MessageEvent 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.category Base required MessageSignificanceCategory 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.mode Base required EventCapabilityMode 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.focus Base required ResourceType . 📍3.0.2 tx.fhir.org
CapabilityStatement.​document.mode Base required DocumentMode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpb-1 error CapabilityStatement A Capability Statement SHALL have at least one of REST, messaging or document element. rest.exists() or messaging.exists() or document.exists()
cpb-2 error CapabilityStatement A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
cpb-3 error CapabilityStatement Messaging end-point is required (and is only permitted) when a statement is for an implementation. messaging.endpoint.empty() or kind = 'instance'
cpb-7 error CapabilityStatement The set of documents must be unique by the combination of profile and mode. document.select(profile.reference&mode).isDistinct()
cpb-8 error CapabilityStatement There can only be one REST declaration per mode. rest.select(mode).isDistinct()
cpb-9 error CapabilityStatement.rest A given resource can only be described once per RESTful mode. resource.select(type).isDistinct()
cpb-12 error CapabilityStatement.rest.resource Search parameter names must be unique in the context of a resource. searchParam.select(name).isDistinct()
cpb-14 error CapabilityStatement Capability Statements of kind 'requirements' do not have software or implementation elements. (software.empty() and implementation.empty()) or kind != 'requirements'
cpb-15 error CapabilityStatement Capability Statements of kind 'instance' do not have implementation elements. implementation.empty() or kind != 'capability'
cpb-16 error CapabilityStatement.messaging A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. supportedMessage.empty() != event.empty()
dom-1 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CapabilityStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CapabilityStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CapabilityStatement

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CapabilityStatement C 1..1 CapabilityStatement A statement of system capabilities
Constraints: cpb-8, cpb-7, cpb-15, cpb-3, cpb-14, cpb-2, cpb-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the CapabilityStatement (business identifier) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:imports 0..* uri R5: Canonical URL of another capability statement this adds to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.imports
.... extension:acceptLanguage 0..* code R5: Languages supported (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.acceptLanguage
.... extension:supportedProfile 0..* uri R5: Use-case specific profiles additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.supportedProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... kind Σ 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
... fhirVersion Σ 1..1 id FHIR Version the system uses
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:fhirVersion 0..1 code R5: FHIR Version the system supports additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.fhirVersion
Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions.
... acceptUnknown Σ 1..1 code no | extensions | elements | both
Binding: UnknownContentCode (required): A code that indicates whether an application accepts unknown elements or extensions when reading resources.
... format Σ 1..* code formats supported (xml | json | ttl | mime type)
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CapabilityStatement.​status Base required PublicationStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​kind Base required CapabilityStatementKind 📍3.0.2 FHIR Std.
CapabilityStatement.​acceptUnknown Base required UnknownContentCode 📍3.0.2 FHIR Std.
CapabilityStatement.​format Base required ​ null (missing link) 📦 unknown?

Constraints

Id Grade Path(s) Description Expression
cpb-1 error CapabilityStatement A Capability Statement SHALL have at least one of REST, messaging or document element. rest.exists() or messaging.exists() or document.exists()
cpb-2 error CapabilityStatement A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
cpb-3 error CapabilityStatement Messaging end-point is required (and is only permitted) when a statement is for an implementation. messaging.endpoint.empty() or kind = 'instance'
cpb-7 error CapabilityStatement The set of documents must be unique by the combination of profile and mode. document.select(profile.reference&mode).isDistinct()
cpb-8 error CapabilityStatement There can only be one REST declaration per mode. rest.select(mode).isDistinct()
cpb-14 error CapabilityStatement Capability Statements of kind 'requirements' do not have software or implementation elements. (software.empty() and implementation.empty()) or kind != 'requirements'
cpb-15 error CapabilityStatement Capability Statements of kind 'instance' do not have implementation elements. implementation.empty() or kind != 'capability'
dom-1 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CapabilityStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CapabilityStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CapabilityStatement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CapabilityStatement 1..1 CapabilityStatement A statement of system capabilities
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the CapabilityStatement (business identifier) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:imports 0..* uri R5: Canonical URL of another capability statement this adds to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.imports
.... extension:acceptLanguage 0..* code R5: Languages supported (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.acceptLanguage
.... extension:supportedProfile 0..* uri R5: Use-case specific profiles additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.supportedProfile
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.contact
... implementation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 Reference(Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Organization that manages the data (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.implementation.custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:fhirVersion 0..1 code R5: FHIR Version the system supports additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.fhirVersion
Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions.
... rest
.... resource
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conditionalPatch 0..1 boolean R5: If allows/uses conditional patch (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.conditionalPatch
..... type
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 0..1 code R5: type additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.type
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
..... profile
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:profile 0..1 uri R5: System-wide profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.profile
..... searchParam
...... type
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:type 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.searchParam.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... operation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:documentation 0..1 markdown R5: Specific details about operation behavior (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.documentation
..... definition
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 0..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.definition
... messaging
.... supportedMessage
..... definition
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 0..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.messaging.supportedMessage.definition
... document
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 0..1 uri R5: Constraint on the resources used in the document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.document.profile

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CapabilityStatement C 1..1 CapabilityStatement A statement of system capabilities
Constraints: cpb-8, cpb-7, cpb-15, cpb-3, cpb-14, cpb-2, cpb-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the CapabilityStatement (business identifier) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:imports 0..* uri R5: Canonical URL of another capability statement this adds to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.imports
.... extension:acceptLanguage 0..* code R5: Languages supported (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.acceptLanguage
.... extension:supportedProfile 0..* uri R5: Use-case specific profiles additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.supportedProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this capability statement (globally unique)
... version Σ 0..1 string Business version of the capability statement
... name Σ 0..1 string Name for this capability statement (computer friendly)
... title Σ 0..1 string Name for this capability statement (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... description C 0..1 markdown Natural language description of the capability statement
... useContext Σ 0..* UsageContext Context the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
... purpose 0..1 markdown Why this capability statement is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... kind Σ 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
... instantiates Σ 0..* uri Canonical URL of another capability statement this implements
... software ΣC 0..1 BackboneElement Software that is covered by this capability statement
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... name Σ 1..1 string A name the software is known by
.... version Σ 0..1 string Version covered by this statement
.... releaseDate Σ 0..1 dateTime Date this version released
... implementation ΣC 0..1 BackboneElement If this describes a specific instance
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 Reference(Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Organization that manages the data (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.implementation.custodian
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... description Σ 1..1 string Describes this specific instance
.... url Σ 0..1 uri Base URL for the installation
... fhirVersion Σ 1..1 id FHIR Version the system uses
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:fhirVersion 0..1 code R5: FHIR Version the system supports additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.fhirVersion
Binding: R5FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions.
.... value 0..1 string Primitive value for id
... acceptUnknown Σ 1..1 code no | extensions | elements | both
Binding: UnknownContentCode (required): A code that indicates whether an application accepts unknown elements or extensions when reading resources.
... format Σ 1..* code formats supported (xml | json | ttl | mime type)
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.
... patchFormat Σ 0..* code Patch formats supported
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.
... implementationGuide Σ 0..* uri Implementation guides supported
... profile Σ 0..* Reference(StructureDefinition) Profiles for use cases supported
... rest ΣC 0..* BackboneElement If the endpoint is a RESTful one
Constraints: cpb-9
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... mode Σ 1..1 code client | server
Binding: RestfulCapabilityMode (required): The mode of a RESTful capability statement.
.... documentation 0..1 string General description of implementation
.... security Σ 0..1 BackboneElement Information about security of implementation
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... cors Σ 0..1 boolean Adds CORS Headers (http://enable-cors.org/)
..... service Σ 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Binding: RestfulSecurityService (extensible): Types of security services used with FHIR.
..... description 0..1 string General description of how security works
..... certificate 0..* BackboneElement Certificates associated with security profiles
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
...... type 0..1 code Mime type for certificates
Binding: (required): The mime type of an attachment. Any valid mime type is allowed.
...... blob 0..1 base64Binary Actual certificate
.... resource ΣC 0..* BackboneElement Resource served on the REST interface
Constraints: cpb-12
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conditionalPatch 0..1 boolean R5: If allows/uses conditional patch (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.conditionalPatch
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... type Σ 1..1 code A resource type that is supported
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 0..1 code R5: type additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.type
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
...... value 0..1 code Primitive value for code
..... profile Σ 0..1 Reference(StructureDefinition) Base System profile for all uses of resource
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:profile 0..1 uri R5: System-wide profile additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.profile
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... documentation 0..1 markdown Additional information about the use of the resource type
..... interaction 1..* BackboneElement What operations are supported?
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
...... code 1..1 code read | vread | update | patch | delete | history-instance | history-type | create | search-type
Binding: TypeRestfulInteraction (required): Operations supported by REST at the type or instance level.
...... documentation 0..1 string Anything special about operation behavior
..... versioning 0..1 code no-version | versioned | versioned-update
Binding: ResourceVersionPolicy (required): How the system supports versioning for a resource.
..... readHistory 0..1 boolean Whether vRead can return past versions
..... updateCreate 0..1 boolean If update can commit to a new identity
..... conditionalCreate 0..1 boolean If allows/uses conditional create
..... conditionalRead 0..1 code not-supported | modified-since | not-match | full-support
Binding: ConditionalReadStatus (required): A code that indicates how the server supports conditional read.
..... conditionalUpdate 0..1 boolean If allows/uses conditional update
..... conditionalDelete 0..1 code not-supported | single | multiple - how conditional delete is supported
Binding: ConditionalDeleteStatus (required): A code that indicates how the server supports conditional delete.
..... referencePolicy 0..* code literal | logical | resolves | enforced | local
Binding: ReferenceHandlingPolicy (required): A set of flags that defines how references are supported.
..... searchInclude 0..* string _include values supported by the server
..... searchRevInclude 0..* string _revinclude values supported by the server
..... searchParam 0..* BackboneElement Search parameters supported by implementation
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
...... name 1..1 string Name of search parameter
...... definition 0..1 uri Source of definition for parameter
...... type 1..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:type 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.searchParam.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
....... value 0..1 code Primitive value for code
...... documentation 0..1 string Server-specific usage
.... interaction 0..* BackboneElement What operations are supported?
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code 1..1 code transaction | batch | search-system | history-system
Binding: SystemRestfulInteraction (required): Operations supported by REST at the system level.
..... documentation 0..1 string Anything special about operation behavior
.... searchParam 0..* See searchParam (CapabilityStatement) Search parameters for searching all resources
.... operation Σ 0..* BackboneElement Definition of an operation or a custom query
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:documentation 0..1 markdown R5: Specific details about operation behavior (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.documentation
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... name 1..1 string Name by which the operation/query is invoked
..... definition Σ 1..1 Reference(OperationDefinition) The defined operation/query
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 1..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.rest.resource.operation.definition
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... compartment 0..* uri Compartments served/used by system
... messaging ΣC 0..* BackboneElement If messaging is supported
Constraints: cpb-16
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... endpoint 0..* BackboneElement Where messages should be sent
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... protocol 1..1 Coding http | ftp | mllp +
Binding: MessageTransport (extensible): The protocol used for message transport.
..... address 1..1 uri Network address or identifier of the end-point
.... reliableCache 0..1 unsignedInt Reliable Message Cache Length (min)
.... documentation 0..1 string Messaging interface behavior details
.... supportedMessage Σ 0..* BackboneElement Messages supported by this system
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... mode Σ 1..1 code sender | receiver
Binding: EventCapabilityMode (required): The mode of a message capability statement.
..... definition Σ 1..1 Reference(MessageDefinition) Message supported by this system
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:definition 1..1 uri R5: definition additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.messaging.supportedMessage.definition
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... event Σ 0..* BackboneElement Declare support for this event
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 Coding Event type
Binding: MessageEvent (example): One of the message events defined as part of FHIR.
..... category 0..1 code Consequence | Currency | Notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.
..... mode 1..1 code sender | receiver
Binding: EventCapabilityMode (required): The mode of a message capability statement.
..... focus 1..1 code Resource that's focus of message
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
..... request Σ 1..1 Reference(StructureDefinition) Profile that describes the request
..... response Σ 1..1 Reference(StructureDefinition) Profile that describes the response
..... documentation 0..1 string Endpoint-specific event documentation
... document ΣC 0..* BackboneElement Document definition
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... mode 1..1 code producer | consumer
Binding: DocumentMode (required): Whether the application produces or consumes documents.
.... documentation 0..1 string Description of document support
.... profile Σ 1..1 Reference(StructureDefinition) Constraint on a resource used in the document
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:profile 1..1 uri R5: Constraint on the resources used in the document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CapabilityStatement.document.profile
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CapabilityStatement.​language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
CapabilityStatement.​status Base required PublicationStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
CapabilityStatement.​kind Base required CapabilityStatementKind 📍3.0.2 FHIR Std.
CapabilityStatement.​acceptUnknown Base required UnknownContentCode 📍3.0.2 FHIR Std.
CapabilityStatement.​format Base required ​ null (missing link) 📦 unknown?
CapabilityStatement.​patchFormat Base required ​ null (missing link) 📦 unknown?
CapabilityStatement.​rest.mode Base required RestfulCapabilityMode 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.security.service Base extensible RestfulSecurityService 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.security.certificate.​type Base required ​ null (missing link) 📦 unknown?
CapabilityStatement.​rest.resource.type Base required ResourceType . 📍3.0.2 tx.fhir.org
CapabilityStatement.​rest.resource.interaction.​code Base required TypeRestfulInteraction 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.versioning Base required ResourceVersionPolicy 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.conditionalRead Base required ConditionalReadStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.conditionalDelete Base required ConditionalDeleteStatus 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.referencePolicy Base required ReferenceHandlingPolicy 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.resource.searchParam.​type Base required SearchParamType 📍3.0.2 FHIR Std.
CapabilityStatement.​rest.interaction.code Base required SystemRestfulInteraction 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.endpoint.protocol Base extensible MessageTransport 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.supportedMessage.​mode Base required EventCapabilityMode 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.code Base example MessageEvent 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.category Base required MessageSignificanceCategory 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.mode Base required EventCapabilityMode 📍3.0.2 FHIR Std.
CapabilityStatement.​messaging.event.focus Base required ResourceType . 📍3.0.2 tx.fhir.org
CapabilityStatement.​document.mode Base required DocumentMode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpb-1 error CapabilityStatement A Capability Statement SHALL have at least one of REST, messaging or document element. rest.exists() or messaging.exists() or document.exists()
cpb-2 error CapabilityStatement A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
cpb-3 error CapabilityStatement Messaging end-point is required (and is only permitted) when a statement is for an implementation. messaging.endpoint.empty() or kind = 'instance'
cpb-7 error CapabilityStatement The set of documents must be unique by the combination of profile and mode. document.select(profile.reference&mode).isDistinct()
cpb-8 error CapabilityStatement There can only be one REST declaration per mode. rest.select(mode).isDistinct()
cpb-9 error CapabilityStatement.rest A given resource can only be described once per RESTful mode. resource.select(type).isDistinct()
cpb-12 error CapabilityStatement.rest.resource Search parameter names must be unique in the context of a resource. searchParam.select(name).isDistinct()
cpb-14 error CapabilityStatement Capability Statements of kind 'requirements' do not have software or implementation elements. (software.empty() and implementation.empty()) or kind != 'requirements'
cpb-15 error CapabilityStatement Capability Statements of kind 'instance' do not have implementation elements. implementation.empty() or kind != 'capability'
cpb-16 error CapabilityStatement.messaging A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. supportedMessage.empty() != event.empty()
dom-1 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CapabilityStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CapabilityStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CapabilityStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CapabilityStatement

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron