NameFlagsCard.TypeDescription & Constraintsdoco
.. Conformance IDomainResourceA conformance statement
Conformance statements of kind 'requirements' do not have software or implementation elements
A Conformance statement SHALL have at least one of REST, messaging or document
Conformance statements of kind 'software' do not have implementation elements
A Conformance statement SHALL have at least one of description, software, or implementation
Messaging end-point is required (and is only permitted) when statement is for an implementation
The set of documents must be unique by the combination of profile & mode
There can only be one REST declaration per mode
... url Σ0..1uriLogical uri to reference this statement
... version Σ0..1stringLogical id for this version of the statement
... name Σ0..1stringInformal name for this conformance statement
... status ?! Σ0..1codedraft | active | retired
ConformanceResourceStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*BackboneElementContact details of the publisher
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... date Σ1..1dateTimePublication Date(/time)
... description Σ I0..1stringHuman description of the conformance statement
... requirements 0..1stringWhy is this needed?
... copyright 0..1stringUse and/or publishing restrictions
... kind Σ1..1codeinstance | capability | requirements
ConformanceStatementKind (Required)
... software Σ I0..1BackboneElementSoftware that is covered by this conformance statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
.... releaseDate Σ0..1dateTimeDate this version released
... implementation Σ I0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1uriBase URL for the installation
... fhirVersion Σ1..1idFHIR Version the system uses
... acceptUnknown Σ1..1codeno | extensions | elements | both
UnknownContentCode (Required)
... format Σ1..*codeformats supported (xml | json | mime type)
MimeType (Required)
... profile 0..*Reference(StructureDefinition)Profiles for use cases supported
... rest Σ I0..*BackboneElementIf the endpoint is a RESTful one
A given resource can only be described once per RESTful mode
.... mode Σ1..1codeclient | server
RestfulConformanceMode (Required)
.... documentation 0..1stringGeneral description of implementation
.... security 0..1BackboneElementInformation about security of implementation
..... cors 0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service 0..*CodeableConceptOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
RestfulSecurityService (Extensible)
..... description 0..1stringGeneral description of how security works
..... certificate 0..*BackboneElementCertificates associated with security profiles
...... type 0..1codeMime type for certificate
MimeType (Required)
...... blob 0..1base64BinaryActual certificate
.... resource Σ I1..*BackboneElementResource served on the REST interface
Search parameter names must be unique in the context of a resource
..... type Σ1..1codeA resource type that is supported
ResourceType (Required)
..... profile 0..1Reference(StructureDefinition)Base System profile for all uses of resource
..... interaction 1..*BackboneElementWhat operations are supported?
...... code 1..1coderead | vread | update | delete | history-instance | validate | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1stringAnything special about operation behavior
..... versioning 0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory 0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1codenot-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
..... searchInclude 0..*string_include values supported by the server
..... searchRevInclude 0..*string_revinclude values supported by the server
..... searchParam I0..*BackboneElementSearch params supported by implementation
Search parameters can only have chain names when the search parameter type is 'reference'
...... name 1..1stringName of search parameter
...... definition 0..1uriSource of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
...... documentation 0..1stringServer-specific usage
...... target 0..*codeTypes of resource (if a resource reference)
ResourceType (Required)
...... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type
SearchModifierCode (Required)
...... chain 0..*stringChained names supported
.... interaction 0..*BackboneElementWhat operations are supported?
..... code 1..1codetransaction | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1stringAnything special about operation behavior
.... transactionMode 0..1codenot-supported | batch | transaction | both
TransactionMode (Required)
.... searchParam 0..*see searchParamSearch params for searching all resources
.... operation 0..*BackboneElementDefinition of an operation or a custom query
..... name 1..1stringName by which the operation/query is invoked
..... definition 1..1Reference(OperationDefinition)The defined operation/query
.... compartment 0..*uriCompartments served/used by system
... messaging I0..*BackboneElementIf messaging is supported
.... endpoint 0..*BackboneElementA messaging service end-point
..... protocol 1..1Codinghttp | ftp | mllp +
MessageTransport (Extensible)
..... address 1..1uriAddress of end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event 1..*BackboneElementDeclare support for this event
..... code 1..1CodingEvent type
MessageEvent (Preferred)
..... category 0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
..... mode 1..1codesender | receiver
ConformanceEventMode (Required)
..... focus 1..1codeResource that's focus of message
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
.... mode 1..1codeproducer | consumer
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