DAF Research, Release 1 Ballot

This page is part of the Data Access Framework (v1.8.0: STU 2 Ballot 2) based on FHIR v1.8.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-daf-capabilitystatement

D.4.1.1 Formal Views of Profile Content

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.

Summary

Mandatory: 5 elements (+10 nested mandatory elements)
Must-Support: 40 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement 1..1
... url S0..1uri
... version S0..1string
... name S0..1string
... status S1..1code
... date S1..1dateTime
... publisher S0..1string
... description S0..1markdown
... kind S1..1code
... implementation S0..1BackboneElement
.... description S1..1string
.... url S0..1uri
... fhirVersion S1..1id
... format S1..*code
... profile S0..*Reference(StructureDefinition)
... rest S0..*BackboneElement
.... mode S1..1code
.... security S0..1BackboneElement
..... cors S0..1boolean
..... service S0..*CodeableConcept
.... resource S0..*BackboneElement
..... type S1..1code
..... profile S0..1Reference(StructureDefinition)
..... documentation S0..1markdown
..... interaction S1..*BackboneElement
...... code S1..1code
...... documentation S0..1string
..... versioning S0..1code
..... readHistory S0..1boolean
..... searchParam S0..*BackboneElement
...... name S1..1string
...... definition S0..1uri
...... type S1..1code
...... target S0..*
.... interaction S0..*BackboneElement
..... code S1..1code
..... documentation S0..1string
.... searchParam S0..*
.... operation S0..*BackboneElement
..... name S1..1string
..... definition S1..1Reference(OperationDefinition)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement I1..1A statement of system Capabilities
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S0..1uriLogical uri to reference this capability statement (globally unique)
... version S0..1stringBusiness version of the capability statement
... name S0..1stringName for this capability statement (Computer friendly)
... title ∑0..1stringName for this capability statement (Human friendly)
... status ?!S1..1codedraft | active | retired
Binding: PublicationStatus (required)
... experimental ?!∑0..1booleanIf for testing purposes, not real usage
... date S1..1dateTimeDate this was last changed
... publisher S0..1stringName of the publisher (Organization or individual)
... contact ∑0..*ContactDetailContact details for the publisher
... description SI0..1markdownNatural language description of the capability statement
... useContext ∑0..*UsageContextContent intends to support these contexts
... jurisdiction ∑0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind S1..1codeinstance | capability | requirements
Binding: CapabilityStatementKind (required)
... instantiates ∑0..*uriCanonical URL of another capability statement this implements
... software ∑I0..1BackboneElementSoftware that is covered by this capability statement
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... name ∑1..1stringA name the software is known by
.... version ∑0..1stringVersion covered by this statement
.... releaseDate ∑0..1dateTimeDate this version released
... implementation SI0..1BackboneElementIf this describes a specific instance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... description S1..1stringDescribes this specific instance
.... url S0..1uriBase URL for the installation
... fhirVersion S1..1idFHIR Version the system uses
... acceptUnknown ∑1..1codeno | extensions | elements | both
Binding: UnknownContentCode (required)
... format S1..*codeformats supported (xml | json | ttl | mime type)
Binding: IETF BCP-13 (required)
... patchFormat ∑0..*codePatch formats supported
Binding: IETF BCP-13 (required)
... implementationGuide ∑0..*uriImplementation Guide supported
... profile S0..*Reference(StructureDefinition)Profiles for use cases supported
... rest SI0..*BackboneElementIf the endpoint is a RESTful one
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode S1..1codeclient | server
Binding: RestfulCapabilityMode (required)
.... documentation 0..1stringGeneral description of implementation
.... security SI0..1BackboneElementInformation about security of implementation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... cors S0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service S0..*CodeableConceptOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Binding: RestfulSecurityService (extensible)
..... description 0..1stringGeneral description of how security works
..... certificate I0..*BackboneElementCertificates associated with security profiles
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
...... type 0..1codeMime type for certificate
Binding: IETF BCP-13 (required)
...... blob 0..1base64BinaryActual certificate
.... resource SI0..*BackboneElementResource served on the REST interface
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type S1..1codeA resource type that is supported
Binding: ResourceType (required)
..... profile S0..1Reference(StructureDefinition)Base System profile for all uses of resource
..... documentation S0..1markdownAdditional information about the use of the resource type
..... interaction SI1..*BackboneElementWhat operations are supported?
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
...... code S1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
Binding: TypeRestfulInteraction (required)
...... documentation S0..1stringAnything special about operation behavior
..... versioning S0..1codeno-version | versioned | versioned-update
Binding: ResourceVersionPolicy (required)
..... readHistory S0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalRead 0..1codenot-supported | modified-since | not-match | full-support
Binding: ConditionalReadStatus (required)
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1codenot-supported | single | multiple - how conditional delete is supported
Binding: ConditionalDeleteStatus (required)
..... referencePolicy 0..*codeliteral | 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 SI0..*BackboneElementSearch params supported by implementation
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
...... name S1..1stringName of search parameter
...... definition S0..1uriSource of definition for parameter
...... type S1..1codenumber | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required)
...... documentation 0..1stringServer-specific usage
.... interaction SI0..*BackboneElementWhat operations are supported?
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... code S1..1codetransaction | batch | search-system | history-system
Binding: SystemRestfulInteraction (required)
..... documentation S0..1stringAnything special about operation behavior
.... searchParam S0..*Unknown reference to #CapabilityStatement:dafcapabilitystatement.rest.resource.searchParam
Search params for searching all resources
.... operation SI0..*BackboneElementDefinition of an operation or a custom query
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... name S1..1stringName by which the operation/query is invoked
..... definition S1..1Reference(OperationDefinition)The defined operation/query
.... compartment 0..*uriCompartments served/used by system
... messaging ∑I0..*BackboneElementIf messaging is supported
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... endpoint I0..*BackboneElementWhere messages should be sent
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... protocol 1..1Codinghttp | ftp | mllp +
Binding: MessageTransport (extensible)
..... address 1..1uriAddress of end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event ∑I1..*BackboneElementDeclare support for this event
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... code ∑1..1CodingEvent type
Binding: MessageEvent (preferred)
..... category 0..1codeConsequence | Currency | Notification
Binding: MessageSignificanceCategory (required)
..... mode 1..1codesender | receiver
Binding: EventCapabilityMode (required)
..... focus 1..1codeResource that's focus of message
Binding: ResourceType (required)
..... request ∑1..1Reference(StructureDefinition)Profile that describes the request
..... response ∑1..1Reference(StructureDefinition)Profile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document ∑I0..*BackboneElementDocument definition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode 1..1codeproducer | consumer
Binding: DocumentMode (required)
.... documentation 0..1stringDescription of document support
.... profile ∑1..1Reference(StructureDefinition)Constraint on a resource used in the document

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement 1..1
... url S0..1uri
... version S0..1string
... name S0..1string
... status S1..1code
... date S1..1dateTime
... publisher S0..1string
... description S0..1markdown
... kind S1..1code
... implementation S0..1BackboneElement
.... description S1..1string
.... url S0..1uri
... fhirVersion S1..1id
... format S1..*code
... profile S0..*Reference(StructureDefinition)
... rest S0..*BackboneElement
.... mode S1..1code
.... security S0..1BackboneElement
..... cors S0..1boolean
..... service S0..*CodeableConcept
.... resource S0..*BackboneElement
..... type S1..1code
..... profile S0..1Reference(StructureDefinition)
..... documentation S0..1markdown
..... interaction S1..*BackboneElement
...... code S1..1code
...... documentation S0..1string
..... versioning S0..1code
..... readHistory S0..1boolean
..... searchParam S0..*BackboneElement
...... name S1..1string
...... definition S0..1uri
...... type S1..1code
...... target S0..*
.... interaction S0..*BackboneElement
..... code S1..1code
..... documentation S0..1string
.... searchParam S0..*
.... operation S0..*BackboneElement
..... name S1..1string
..... definition S1..1Reference(OperationDefinition)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement I1..1A statement of system Capabilities
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S0..1uriLogical uri to reference this capability statement (globally unique)
... version S0..1stringBusiness version of the capability statement
... name S0..1stringName for this capability statement (Computer friendly)
... title ∑0..1stringName for this capability statement (Human friendly)
... status ?!S1..1codedraft | active | retired
Binding: PublicationStatus (required)
... experimental ?!∑0..1booleanIf for testing purposes, not real usage
... date S1..1dateTimeDate this was last changed
... publisher S0..1stringName of the publisher (Organization or individual)
... contact ∑0..*ContactDetailContact details for the publisher
... description SI0..1markdownNatural language description of the capability statement
... useContext ∑0..*UsageContextContent intends to support these contexts
... jurisdiction ∑0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind S1..1codeinstance | capability | requirements
Binding: CapabilityStatementKind (required)
... instantiates ∑0..*uriCanonical URL of another capability statement this implements
... software ∑I0..1BackboneElementSoftware that is covered by this capability statement
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... name ∑1..1stringA name the software is known by
.... version ∑0..1stringVersion covered by this statement
.... releaseDate ∑0..1dateTimeDate this version released
... implementation SI0..1BackboneElementIf this describes a specific instance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... description S1..1stringDescribes this specific instance
.... url S0..1uriBase URL for the installation
... fhirVersion S1..1idFHIR Version the system uses
... acceptUnknown ∑1..1codeno | extensions | elements | both
Binding: UnknownContentCode (required)
... format S1..*codeformats supported (xml | json | ttl | mime type)
Binding: IETF BCP-13 (required)
... patchFormat ∑0..*codePatch formats supported
Binding: IETF BCP-13 (required)
... implementationGuide ∑0..*uriImplementation Guide supported
... profile S0..*Reference(StructureDefinition)Profiles for use cases supported
... rest SI0..*BackboneElementIf the endpoint is a RESTful one
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode S1..1codeclient | server
Binding: RestfulCapabilityMode (required)
.... documentation 0..1stringGeneral description of implementation
.... security SI0..1BackboneElementInformation about security of implementation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... cors S0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service S0..*CodeableConceptOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Binding: RestfulSecurityService (extensible)
..... description 0..1stringGeneral description of how security works
..... certificate I0..*BackboneElementCertificates associated with security profiles
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
...... type 0..1codeMime type for certificate
Binding: IETF BCP-13 (required)
...... blob 0..1base64BinaryActual certificate
.... resource SI0..*BackboneElementResource served on the REST interface
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type S1..1codeA resource type that is supported
Binding: ResourceType (required)
..... profile S0..1Reference(StructureDefinition)Base System profile for all uses of resource
..... documentation S0..1markdownAdditional information about the use of the resource type
..... interaction SI1..*BackboneElementWhat operations are supported?
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
...... code S1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
Binding: TypeRestfulInteraction (required)
...... documentation S0..1stringAnything special about operation behavior
..... versioning S0..1codeno-version | versioned | versioned-update
Binding: ResourceVersionPolicy (required)
..... readHistory S0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalRead 0..1codenot-supported | modified-since | not-match | full-support
Binding: ConditionalReadStatus (required)
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1codenot-supported | single | multiple - how conditional delete is supported
Binding: ConditionalDeleteStatus (required)
..... referencePolicy 0..*codeliteral | 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 SI0..*BackboneElementSearch params supported by implementation
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
...... name S1..1stringName of search parameter
...... definition S0..1uriSource of definition for parameter
...... type S1..1codenumber | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required)
...... documentation 0..1stringServer-specific usage
.... interaction SI0..*BackboneElementWhat operations are supported?
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... code S1..1codetransaction | batch | search-system | history-system
Binding: SystemRestfulInteraction (required)
..... documentation S0..1stringAnything special about operation behavior
.... searchParam S0..*Unknown reference to #CapabilityStatement:dafcapabilitystatement.rest.resource.searchParam
Search params for searching all resources
.... operation SI0..*BackboneElementDefinition of an operation or a custom query
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... name S1..1stringName by which the operation/query is invoked
..... definition S1..1Reference(OperationDefinition)The defined operation/query
.... compartment 0..*uriCompartments served/used by system
... messaging ∑I0..*BackboneElementIf messaging is supported
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... endpoint I0..*BackboneElementWhere messages should be sent
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... protocol 1..1Codinghttp | ftp | mllp +
Binding: MessageTransport (extensible)
..... address 1..1uriAddress of end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event ∑I1..*BackboneElementDeclare support for this event
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... code ∑1..1CodingEvent type
Binding: MessageEvent (preferred)
..... category 0..1codeConsequence | Currency | Notification
Binding: MessageSignificanceCategory (required)
..... mode 1..1codesender | receiver
Binding: EventCapabilityMode (required)
..... focus 1..1codeResource that's focus of message
Binding: ResourceType (required)
..... request ∑1..1Reference(StructureDefinition)Profile that describes the request
..... response ∑1..1Reference(StructureDefinition)Profile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document ∑I0..*BackboneElementDocument definition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... mode 1..1codeproducer | consumer
Binding: DocumentMode (required)
.... documentation 0..1stringDescription of document support
.... profile ∑1..1Reference(StructureDefinition)Constraint on a resource used in the document

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron