This is the set of resources that conform to either of the profiles CRMI Publishable CapabilityStatement (http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablecapabilitystatement) and CRMI Publishable CapabilityStatement (http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablecapabilitystatement). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CapabilityStatement | C | 1..1 | A statement of system capabilities cpb-0: Name should be usable as an identifier for the module by machine processing applications such as code generation cpb-1: A Capability Statement SHALL have at least one of REST, messaging or document element. cpb-2: A Capability Statement SHALL have at least one of description, software, or implementation element. cpb-3: Messaging end-point is required (and is only permitted) when a statement is for an implementation. cpb-7: The set of documents must be unique by the combination of profile and mode. cpb-14: If kind = instance, implementation must be present and software may be present cpb-15: If kind = capability, implementation must be absent, software must be present cpb-16: If kind = requirements, implementation and software must be absent dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | Σ | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Business version of the capability statement ele-1: All FHIR elements must have a @value or children |
name | Σ | 0..1 | string | Name for this capability statement (computer friendly) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Name for this capability statement (human friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | SΣ | 1..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | 0..1 | markdown | Natural language description of the capability statement ele-1: All FHIR elements must have a @value or children | |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
purpose | S | 0..1 | markdown | Why this capability statement is defined ele-1: All FHIR elements must have a @value or children |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children |
kind | Σ | 1..1 | code | instance | capability | requirements Binding: ?? (required): How a capability statement is intended to be used. ele-1: All FHIR elements must have a @value or children |
instantiates | Σ | 0..* | canonical(CapabilityStatement) | Canonical URL of another capability statement this implements ele-1: All FHIR elements must have a @value or children |
imports | Σ | 0..* | canonical(CapabilityStatement) | Canonical URL of another capability statement this adds to ele-1: All FHIR elements must have a @value or children |
software | Σ | 0..1 | BackboneElement | Software that is covered by this capability statement ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | A name the software is known by ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Version covered by this statement ele-1: All FHIR elements must have a @value or children |
releaseDate | Σ | 0..1 | dateTime | Date this version was released ele-1: All FHIR elements must have a @value or children |
implementation | Σ | 0..1 | BackboneElement | If this describes a specific instance ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
description | Σ | 1..1 | string | Describes this specific instance ele-1: All FHIR elements must have a @value or children |
url | Σ | 0..1 | url | Base URL for the installation ele-1: All FHIR elements must have a @value or children |
custodian | Σ | 0..1 | Reference(Organization) | Organization that manages the data ele-1: All FHIR elements must have a @value or children |
fhirVersion | Σ | 1..1 | code | FHIR Version the system supports Binding: ?? (required): All published FHIR Versions. ele-1: All FHIR elements must have a @value or children |
format | Σ | 1..* | code | formats supported (xml | json | ttl | mime type) Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children |
patchFormat | Σ | 0..* | code | Patch formats supported Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children |
implementationGuide | Σ | 0..* | canonical(ImplementationGuide) | Implementation guides supported ele-1: All FHIR elements must have a @value or children |
rest | ΣC | 0..* | BackboneElement | If the endpoint is a RESTful one cpb-9: A given resource can only be described once per RESTful mode. ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mode | Σ | 1..1 | code | client | server Binding: ?? (required): The mode of a RESTful capability statement. ele-1: All FHIR elements must have a @value or children |
documentation | 0..1 | markdown | General description of implementation ele-1: All FHIR elements must have a @value or children | |
security | Σ | 0..1 | BackboneElement | Information about security of implementation ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
cors | Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) ele-1: All FHIR elements must have a @value or children |
service | Σ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates Binding: ?? (extensible): Types of security services used with FHIR. ele-1: All FHIR elements must have a @value or children |
description | 0..1 | markdown | General description of how security works ele-1: All FHIR elements must have a @value or children | |
resource | ΣC | 0..* | BackboneElement | Resource served on the REST interface cpb-12: Search parameter names must be unique in the context of a resource. ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | Σ | 1..1 | code | A resource type that is supported Binding: ?? (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children |
profile | Σ | 0..1 | canonical(StructureDefinition) | Base System profile for all uses of resource ele-1: All FHIR elements must have a @value or children |
supportedProfile | Σ | 0..* | canonical(StructureDefinition) | Profiles for use cases supported ele-1: All FHIR elements must have a @value or children |
documentation | 0..1 | markdown | Additional information about the use of the resource type ele-1: All FHIR elements must have a @value or children | |
interaction | 0..* | BackboneElement | What operations are supported? ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type Binding: ?? (required): Operations supported by REST at the type or instance level. ele-1: All FHIR elements must have a @value or children | |
documentation | 0..1 | markdown | Anything special about operation behavior ele-1: All FHIR elements must have a @value or children | |
versioning | 0..1 | code | no-version | versioned | versioned-update Binding: ?? (required): How the system supports versioning for a resource. ele-1: All FHIR elements must have a @value or children | |
readHistory | 0..1 | boolean | Whether vRead can return past versions ele-1: All FHIR elements must have a @value or children | |
updateCreate | 0..1 | boolean | If update can commit to a new identity ele-1: All FHIR elements must have a @value or children | |
conditionalCreate | 0..1 | boolean | If allows/uses conditional create ele-1: All FHIR elements must have a @value or children | |
conditionalRead | 0..1 | code | not-supported | modified-since | not-match | full-support Binding: ?? (required): A code that indicates how the server supports conditional read. ele-1: All FHIR elements must have a @value or children | |
conditionalUpdate | 0..1 | boolean | If allows/uses conditional update ele-1: All FHIR elements must have a @value or children | |
conditionalDelete | 0..1 | code | not-supported | single | multiple - how conditional delete is supported Binding: ?? (required): A code that indicates how the server supports conditional delete. ele-1: All FHIR elements must have a @value or children | |
referencePolicy | 0..* | code | literal | logical | resolves | enforced | local Binding: ?? (required): A set of flags that defines how references are supported. ele-1: All FHIR elements must have a @value or children | |
searchInclude | 0..* | string | _include values supported by the server ele-1: All FHIR elements must have a @value or children | |
searchRevInclude | 0..* | string | _revinclude values supported by the server ele-1: All FHIR elements must have a @value or children | |
searchParam | 0..* | BackboneElement | Search parameters supported by implementation ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | 1..1 | string | Name of search parameter ele-1: All FHIR elements must have a @value or children | |
definition | 0..1 | canonical(SearchParameter) | Source of definition for parameter ele-1: All FHIR elements must have a @value or children | |
type | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: ?? (required): Data types allowed to be used for search parameters. ele-1: All FHIR elements must have a @value or children | |
documentation | 0..1 | markdown | Server-specific usage ele-1: All FHIR elements must have a @value or children | |
operation | Σ | 0..* | BackboneElement | Definition of a resource operation ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name by which the operation/query is invoked ele-1: All FHIR elements must have a @value or children |
definition | Σ | 1..1 | canonical(OperationDefinition) | The defined operation/query ele-1: All FHIR elements must have a @value or children |
documentation | 0..1 | markdown | Specific details about operation behavior ele-1: All FHIR elements must have a @value or children | |
interaction | 0..* | BackboneElement | What operations are supported? ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | 1..1 | code | transaction | batch | search-system | history-system Binding: ?? (required): Operations supported by REST at the system level. ele-1: All FHIR elements must have a @value or children | |
documentation | 0..1 | markdown | Anything special about operation behavior ele-1: All FHIR elements must have a @value or children | |
searchParam | 0..* | Search parameters for searching all resources ele-1: All FHIR elements must have a @value or children | ||
operation | Σ | 0..* | Definition of a system level operation ele-1: All FHIR elements must have a @value or children | |
compartment | 0..* | canonical(CompartmentDefinition) | Compartments served/used by system ele-1: All FHIR elements must have a @value or children | |
messaging | Σ | 0..* | BackboneElement | If messaging is supported ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
endpoint | 0..* | BackboneElement | Where messages should be sent ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
protocol | 1..1 | Coding | http | ftp | mllp + Binding: ?? (extensible): The protocol used for message transport. ele-1: All FHIR elements must have a @value or children | |
address | 1..1 | url | Network address or identifier of the end-point ele-1: All FHIR elements must have a @value or children | |
reliableCache | 0..1 | unsignedInt | Reliable Message Cache Length (min) ele-1: All FHIR elements must have a @value or children | |
documentation | 0..1 | markdown | Messaging interface behavior details ele-1: All FHIR elements must have a @value or children | |
supportedMessage | Σ | 0..* | BackboneElement | Messages supported by this system ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mode | Σ | 1..1 | code | sender | receiver Binding: ?? (required): The mode of a message capability statement. ele-1: All FHIR elements must have a @value or children |
definition | Σ | 1..1 | canonical(MessageDefinition) | Message supported by this system ele-1: All FHIR elements must have a @value or children |
document | Σ | 0..* | BackboneElement | Document definition ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mode | Σ | 1..1 | code | producer | consumer Binding: ?? (required): Whether the application produces or consumes documents. ele-1: All FHIR elements must have a @value or children |
documentation | 0..1 | markdown | Description of document support ele-1: All FHIR elements must have a @value or children | |
profile | Σ | 1..1 | canonical(StructureDefinition) | Constraint on the resources used in the document ele-1: All FHIR elements must have a @value or children |
Documentation for this format |