STU 2 Ballot
This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/daf/StructureDefinition/daf-conformance
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.
This structure is derived from Conformance
This structure is derived from Conformance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Conformance | I | 1..1 | A conformance statement dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource cnf-8: There can only be one REST declaration per mode cnf-7: The set of documents must be unique by the combination of profile & mode cnf-2: A Conformance statement SHALL have at least one of description, software, or implementation cnf-3: Messaging end-point is required (and is only permitted) when statement is for an implementation cnf-1: A Conformance statement SHALL have at least one of REST, messaging or document cnf-14: Conformance statements of kind 'requirements' do not have software or implementation elements cnf-15: Conformance statements of kind 'software' do not have implementation elements | |
  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 statement |
| version | S | 0..1 | string | Logical id for this version of the statement |
| name | S | 0..1 | string | Informal name for this conformance statement |
| status | ?!S | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
| experimental | ∑ | 0..1 | boolean | If for testing purposes, not real usage |
| date | S | 1..1 | dateTime | Publication Date(/time) |
| publisher | S | 0..1 | string | Name of the publisher (Organization or individual) |
| contact | ∑ | 0..* | BackboneElement | Contact details of the publisher |
 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 | ∑ | 0..1 | string | Name of an individual to contact |
 telecom | ∑ | 0..* | ContactPoint | Contact details for individual or publisher |
| description | SI | 0..1 | markdown | Human description of the conformance statement |
| useContext | ∑ | 0..* | CodeableConcept | Content intends to support these contexts Binding: Context of Use ValueSet (extensible) |
| requirements | 0..1 | markdown | Why this resource has been created | |
| copyright | 0..1 | string | Use and/or publishing restrictions | |
| kind | S | 1..1 | code | instance | capability | requirements Binding: ConformanceStatementKind (required) |
| instantiates | ∑ | 0..* | uri | Canonical URL of service implemented/used by software |
| software | ∑I | 0..1 | BackboneElement | Software that is covered by this conformance 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 | SI | 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) |
 profile | S | 0..* | Reference(StructureDefinition) | Profiles for use cases supported |
| rest | SI | 0..* | BackboneElement | If the endpoint is a RESTful one cnf-9: A given resource can only be described once per RESTful mode |
| 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: RestfulConformanceMode (required) |
| documentation | 0..1 | string | General description of implementation | |
| security | S | 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 | 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 certificate Binding: IETF BCP-13 (required) | |
| blob | 0..1 | base64Binary | Actual certificate | |
| resource | SI | 0..* | BackboneElement | Resource served on the REST interface cnf-12: Search parameter names must be unique in the context of a resource |
| 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 | S | 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 | 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) | |
| searchInclude | 0..* | string | _include values supported by the server | |
| searchRevInclude | 0..* | string | _revinclude values supported by the server | |
| searchParam | SI | 0..* | BackboneElement | Search params supported by implementation cnf-13: Search parameters can only have chain names when the search parameter type is 'reference' |
| 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 | |
| target | S | 0..* | code | Types of resource (if a resource reference) Binding: ResourceType (required) |
| modifier | 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type Binding: SearchModifierCode (required) | |
| chain | 0..* | string | Chained names supported | |
| interaction | S | 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 #Conformance:dafconformance.rest.resource.searchParam Search params for searching all resources | |
| operation | S | 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 |
| 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) | |
| address | 1..1 | uri | Address of end-point | |
| reliableCache | 0..1 | unsignedInt | Reliable Message Cache Length (min) | |
| documentation | 0..1 | string | Messaging interface behavior details | |
| event | ∑ | 1..* | 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 (preferred) |
| category | 0..1 | code | Consequence | Currency | Notification Binding: MessageSignificanceCategory (required) | |
| mode | 1..1 | code | sender | receiver Binding: ConformanceEventMode (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 | ||||
yet to be done: Xml template
yet to be done: Json template
This structure is derived from Conformance.
Differential View
This structure is derived from Conformance.
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Conformance | I | 1..1 | A conformance statement dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource cnf-8: There can only be one REST declaration per mode cnf-7: The set of documents must be unique by the combination of profile & mode cnf-2: A Conformance statement SHALL have at least one of description, software, or implementation cnf-3: Messaging end-point is required (and is only permitted) when statement is for an implementation cnf-1: A Conformance statement SHALL have at least one of REST, messaging or document cnf-14: Conformance statements of kind 'requirements' do not have software or implementation elements cnf-15: Conformance statements of kind 'software' do not have implementation elements | |
| 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 statement |
| version | S | 0..1 | string | Logical id for this version of the statement |
| name | S | 0..1 | string | Informal name for this conformance statement |
| status | ?!S | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
| experimental | ∑ | 0..1 | boolean | If for testing purposes, not real usage |
| date | S | 1..1 | dateTime | Publication Date(/time) |
| publisher | S | 0..1 | string | Name of the publisher (Organization or individual) |
| contact | ∑ | 0..* | BackboneElement | Contact details of the publisher |
| 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 | ∑ | 0..1 | string | Name of an individual to contact |
| telecom | ∑ | 0..* | ContactPoint | Contact details for individual or publisher |
| description | SI | 0..1 | markdown | Human description of the conformance statement |
| useContext | ∑ | 0..* | CodeableConcept | Content intends to support these contexts Binding: Context of Use ValueSet (extensible) |
| requirements | 0..1 | markdown | Why this resource has been created | |
| copyright | 0..1 | string | Use and/or publishing restrictions | |
| kind | S | 1..1 | code | instance | capability | requirements Binding: ConformanceStatementKind (required) |
| instantiates | ∑ | 0..* | uri | Canonical URL of service implemented/used by software |
| software | ∑I | 0..1 | BackboneElement | Software that is covered by this conformance 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 | SI | 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) |
| profile | S | 0..* | Reference(StructureDefinition) | Profiles for use cases supported |
| rest | SI | 0..* | BackboneElement | If the endpoint is a RESTful one cnf-9: A given resource can only be described once per RESTful mode |
| 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: RestfulConformanceMode (required) |
| documentation | 0..1 | string | General description of implementation | |
| security | S | 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 | 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 certificate Binding: IETF BCP-13 (required) | |
| blob | 0..1 | base64Binary | Actual certificate | |
| resource | SI | 0..* | BackboneElement | Resource served on the REST interface cnf-12: Search parameter names must be unique in the context of a resource |
| 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 | S | 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 | 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) | |
| searchInclude | 0..* | string | _include values supported by the server | |
| searchRevInclude | 0..* | string | _revinclude values supported by the server | |
| searchParam | SI | 0..* | BackboneElement | Search params supported by implementation cnf-13: Search parameters can only have chain names when the search parameter type is 'reference' |
| 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 | |
| target | S | 0..* | code | Types of resource (if a resource reference) Binding: ResourceType (required) |
| modifier | 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type Binding: SearchModifierCode (required) | |
| chain | 0..* | string | Chained names supported | |
| interaction | S | 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 #Conformance:dafconformance.rest.resource.searchParam Search params for searching all resources | |
| operation | S | 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 |
| 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) | |
| address | 1..1 | uri | Address of end-point | |
| reliableCache | 0..1 | unsignedInt | Reliable Message Cache Length (min) | |
| documentation | 0..1 | string | Messaging interface behavior details | |
| event | ∑ | 1..* | 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 (preferred) |
| category | 0..1 | code | Consequence | Currency | Notification Binding: MessageSignificanceCategory (required) | |
| mode | 1..1 | code | sender | receiver Binding: ConformanceEventMode (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 | ||||
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
| Path | Name | Conformance | ValueSet |
| Conformance.language | Common Languages | extensible | Common Languages |
| Conformance.status | ConformanceResourceStatus | required | ConformanceResourceStatus |
| Conformance.useContext | Context of Use ValueSet | extensible | Context of Use ValueSet |
| Conformance.kind | ConformanceStatementKind | required | ConformanceStatementKind |
| Conformance.acceptUnknown | UnknownContentCode | required | UnknownContentCode |
| Conformance.format | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Conformance.rest.mode | RestfulConformanceMode | required | RestfulConformanceMode |
| Conformance.rest.security.service | RestfulSecurityService | extensible | RestfulSecurityService |
| Conformance.rest.security.certificate.type | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Conformance.rest.resource.type | ResourceType | required | ResourceType |
| Conformance.rest.resource.interaction.code | TypeRestfulInteraction | required | TypeRestfulInteraction |
| Conformance.rest.resource.versioning | ResourceVersionPolicy | required | ResourceVersionPolicy |
| Conformance.rest.resource.conditionalRead | ConditionalReadStatus | required | ConditionalReadStatus |
| Conformance.rest.resource.conditionalDelete | ConditionalDeleteStatus | required | ConditionalDeleteStatus |
| Conformance.rest.resource.searchParam.type | SearchParamType | required | SearchParamType |
| Conformance.rest.resource.searchParam.target | ResourceType | required | ResourceType |
| Conformance.rest.resource.searchParam.modifier | SearchModifierCode | required | SearchModifierCode |
| Conformance.rest.interaction.code | SystemRestfulInteraction | required | SystemRestfulInteraction |
| Conformance.messaging.endpoint.protocol | MessageTransport | extensible | MessageTransport |
| Conformance.messaging.event.code | MessageEvent | preferred | MessageEvent |
| Conformance.messaging.event.category | MessageSignificanceCategory | required | MessageSignificanceCategory |
| Conformance.messaging.event.mode | ConformanceEventMode | required | ConformanceEventMode |
| Conformance.messaging.event.focus | ResourceType | required | ResourceType |
| Conformance.document.mode | DocumentMode | required | DocumentMode |
| Id | Path | Details | Requirements |
| dom-2 | Conformance | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
| dom-1 | Conformance | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
| dom-4 | Conformance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
| dom-3 | Conformance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
| cnf-8 | Conformance | There can only be one REST declaration per mode XPath: count(f:rest)=count(distinct-values(f:rest/f:mode/@value)) | |
| cnf-7 | Conformance | The set of documents must be unique by the combination of profile & mode XPath: count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value)) | |
| cnf-2 | Conformance | A Conformance statement SHALL have at least one of description, software, or implementation XPath: count(f:software | f:implementation | f:description) > 0 | |
| cnf-3 | Conformance | Messaging end-point is required (and is only permitted) when statement is for an implementation XPath: not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance' | |
| cnf-1 | Conformance | A Conformance statement SHALL have at least one of REST, messaging or document XPath: exists(f:rest) or exists(f:messaging) or exists(f:document) | |
| cnf-14 | Conformance | Conformance statements of kind 'requirements' do not have software or implementation elements XPath: not(exists(f:software) or exists(f:implementation)) or (f:kind/@value != 'requirements') | |
| cnf-15 | Conformance | Conformance statements of kind 'software' do not have implementation elements XPath: not(exists(f:implementation)) or (f:kind/@value != 'capability') | |
| cnf-9 | Conformance.rest | A given resource can only be described once per RESTful mode XPath: count(f:resource)=count(distinct-values(f:resource/f:type/@value)) | |
| cnf-12 | Conformance.rest.resource | Search parameter names must be unique in the context of a resource XPath: count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value)) | |
| cnf-13 | Conformance.rest.resource.searchParam | Search parameters can only have chain names when the search parameter type is 'reference' XPath: not(exists(f:chain)) or (f:type/@value = 'reference') |
© HL7.org 2011+. DAF STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change