DAF Research Implementation Guide v2.0.0 (STU2)
The official URL for this profile is:
http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-capabilitystatement
This profile builds on CapabilityStatement.
This profile was published on Fri Aug 12 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR Infrastructure WG - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CapabilityStatement | I | 1..1 | A statement of system capabilities | |
  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) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 0..1 | uri | Logical URI to reference this capability statement (globally unique) |
| version | SΣ | 0..1 | string | Business version of the capability statement |
| name | SΣ | 0..1 | string | Name for this capability statement (computer friendly) |
| title | Σ | 0..1 | string | Name for this capability statement (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 1..1 | dateTime | Date this was last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | SI | 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) |
| purpose | 0..1 | markdown | Why this capability statement is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| kind | SΣ | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required) |
| instantiates | Σ | 0..* | uri | Canonical URL of another capability statement this implements |
| software | ΣI | 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 | SΣI | 0..1 | BackboneElement | If this describes a specific instance |
| 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 |
| description | SΣ | 1..1 | string | Describes this specific instance |
| url | SΣ | 0..1 | uri | Base URL for the installation |
| fhirVersion | SΣ | 1..1 | id | FHIR Version the system uses |
| acceptUnknown | Σ | 1..1 | code | no | extensions | elements | both Binding: UnknownContentCode (required) |
| format | SΣ | 1..* | code | formats supported (xml | json | ttl | mime type) Binding: IETF BCP-13 (required) |
| patchFormat | Σ | 0..* | code | Patch formats supported Binding: IETF BCP-13 (required) |
| implementationGuide | Σ | 0..* | uri | Implementation guides supported |
 profile | SΣ | 0..* | Reference(StructureDefinition) | Profiles for use cases supported |
| rest | SΣI | 0..* | BackboneElement | If the endpoint is a RESTful one |
| 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 | SΣ | 1..1 | code | client | server Binding: RestfulCapabilityMode (required) |
| documentation | 0..1 | string | General description of implementation | |
| security | SΣI | 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 | SΣ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
| service | SΣ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates Binding: RestfulSecurityService (extensible) |
| description | 0..1 | string | General description of how security works | |
| certificate | I | 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: IETF BCP-13 (required) | |
| blob | 0..1 | base64Binary | Actual certificate | |
| resource | SΣI | 0..* | BackboneElement | Resource served on the REST interface |
| 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 | SΣ | 1..1 | code | A resource type that is supported Binding: ResourceType (required) |
| profile | SΣ | 0..1 | Reference(StructureDefinition) | Base System profile for all uses of resource |
| documentation | S | 0..1 | markdown | Additional information about the use of the resource type |
| interaction | SI | 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 | S | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type Binding: TypeRestfulInteraction (required) |
| documentation | S | 0..1 | string | Anything special about operation behavior |
| versioning | S | 0..1 | code | no-version | versioned | versioned-update Binding: ResourceVersionPolicy (required) |
| readHistory | S | 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) | |
| 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) | |
| referencePolicy | 0..* | code | literal | logical | resolves | enforced | local Binding: ReferenceHandlingPolicy (required) | |
| searchInclude | 0..* | string | _include values supported by the server | |
| searchRevInclude | 0..* | string | _revinclude values supported by the server | |
| searchParam | SI | 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 | S | 1..1 | string | Name of search parameter |
| definition | S | 0..1 | uri | Source of definition for parameter |
| type | S | 1..1 | code | number | date | string | token | reference | composite | quantity | uri Binding: SearchParamType (required) |
| documentation | 0..1 | string | Server-specific usage | |
| interaction | SI | 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 | S | 1..1 | code | transaction | batch | search-system | history-system Binding: SystemRestfulInteraction (required) |
| documentation | S | 0..1 | string | Anything special about operation behavior |
| searchParam | S | 0..* | Unknown reference to #CapabilityStatement:dafcapabilitystatement.rest.resource.searchParam Search parameters for searching all resources | |
| operation | SΣI | 0..* | BackboneElement | Definition of an operation or a custom query |
| 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 | S | 1..1 | string | Name by which the operation/query is invoked |
| definition | SΣ | 1..1 | Reference(OperationDefinition) | The defined operation/query |
| compartment | 0..* | uri | Compartments served/used by system | |
| messaging | ΣI | 0..* | BackboneElement | If messaging is supported cpb-16: A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. |
| 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 | I | 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) | |
| 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 | ΣI | 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) |
| definition | Σ | 1..1 | Reference(MessageDefinition) | Message supported by this system |
| event | ΣI | 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) |
| category | 0..1 | code | Consequence | Currency | Notification Binding: MessageSignificanceCategory (required) | |
| mode | 1..1 | code | sender | receiver Binding: EventCapabilityMode (required) | |
| focus | 1..1 | code | Resource that's focus of message Binding: ResourceType (required) | |
| 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 | ΣI | 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) | |
| documentation | 0..1 | string | Description of document support | |
| profile | Σ | 1..1 | Reference(StructureDefinition) | Constraint on a resource used in the document |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CapabilityStatement | I | 1..1 | A statement of system capabilities | |
| 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) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 0..1 | uri | Logical URI to reference this capability statement (globally unique) |
| version | SΣ | 0..1 | string | Business version of the capability statement |
| name | SΣ | 0..1 | string | Name for this capability statement (computer friendly) |
| title | Σ | 0..1 | string | Name for this capability statement (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 1..1 | dateTime | Date this was last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | SI | 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) |
| purpose | 0..1 | markdown | Why this capability statement is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| kind | SΣ | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required) |
| instantiates | Σ | 0..* | uri | Canonical URL of another capability statement this implements |
| software | ΣI | 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 | SΣI | 0..1 | BackboneElement | If this describes a specific instance |
| 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 |
| description | SΣ | 1..1 | string | Describes this specific instance |
| url | SΣ | 0..1 | uri | Base URL for the installation |
| fhirVersion | SΣ | 1..1 | id | FHIR Version the system uses |
| acceptUnknown | Σ | 1..1 | code | no | extensions | elements | both Binding: UnknownContentCode (required) |
| format | SΣ | 1..* | code | formats supported (xml | json | ttl | mime type) Binding: IETF BCP-13 (required) |
| patchFormat | Σ | 0..* | code | Patch formats supported Binding: IETF BCP-13 (required) |
| implementationGuide | Σ | 0..* | uri | Implementation guides supported |
| profile | SΣ | 0..* | Reference(StructureDefinition) | Profiles for use cases supported |
| rest | SΣI | 0..* | BackboneElement | If the endpoint is a RESTful one |
| 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 | SΣ | 1..1 | code | client | server Binding: RestfulCapabilityMode (required) |
| documentation | 0..1 | string | General description of implementation | |
| security | SΣI | 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 | SΣ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
| service | SΣ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates Binding: RestfulSecurityService (extensible) |
| description | 0..1 | string | General description of how security works | |
| certificate | I | 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: IETF BCP-13 (required) | |
| blob | 0..1 | base64Binary | Actual certificate | |
| resource | SΣI | 0..* | BackboneElement | Resource served on the REST interface |
| 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 | SΣ | 1..1 | code | A resource type that is supported Binding: ResourceType (required) |
| profile | SΣ | 0..1 | Reference(StructureDefinition) | Base System profile for all uses of resource |
| documentation | S | 0..1 | markdown | Additional information about the use of the resource type |
| interaction | SI | 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 | S | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type Binding: TypeRestfulInteraction (required) |
| documentation | S | 0..1 | string | Anything special about operation behavior |
| versioning | S | 0..1 | code | no-version | versioned | versioned-update Binding: ResourceVersionPolicy (required) |
| readHistory | S | 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) | |
| 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) | |
| referencePolicy | 0..* | code | literal | logical | resolves | enforced | local Binding: ReferenceHandlingPolicy (required) | |
| searchInclude | 0..* | string | _include values supported by the server | |
| searchRevInclude | 0..* | string | _revinclude values supported by the server | |
| searchParam | SI | 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 | S | 1..1 | string | Name of search parameter |
| definition | S | 0..1 | uri | Source of definition for parameter |
| type | S | 1..1 | code | number | date | string | token | reference | composite | quantity | uri Binding: SearchParamType (required) |
| documentation | 0..1 | string | Server-specific usage | |
| interaction | SI | 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 | S | 1..1 | code | transaction | batch | search-system | history-system Binding: SystemRestfulInteraction (required) |
| documentation | S | 0..1 | string | Anything special about operation behavior |
| searchParam | S | 0..* | Unknown reference to #CapabilityStatement:dafcapabilitystatement.rest.resource.searchParam Search parameters for searching all resources | |
| operation | SΣI | 0..* | BackboneElement | Definition of an operation or a custom query |
| 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 | S | 1..1 | string | Name by which the operation/query is invoked |
| definition | SΣ | 1..1 | Reference(OperationDefinition) | The defined operation/query |
| compartment | 0..* | uri | Compartments served/used by system | |
| messaging | ΣI | 0..* | BackboneElement | If messaging is supported cpb-16: A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. |
| 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 | I | 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) | |
| 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 | ΣI | 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) |
| definition | Σ | 1..1 | Reference(MessageDefinition) | Message supported by this system |
| event | ΣI | 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) |
| category | 0..1 | code | Consequence | Currency | Notification Binding: MessageSignificanceCategory (required) | |
| mode | 1..1 | code | sender | receiver Binding: EventCapabilityMode (required) | |
| focus | 1..1 | code | Resource that's focus of message Binding: ResourceType (required) | |
| 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 | ΣI | 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) | |
| documentation | 0..1 | string | Description of document support | |
| profile | Σ | 1..1 | Reference(StructureDefinition) | Constraint on a resource used in the document |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
DAF Research v2.0.0 (STU2) © based on FHIR STU3 Version: 3.0.1 generated on Fri, Apr 21, 2017 08:00+1000. |
