This page is part of the FHIR Specification (v0.11: DSTU 1 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Example Index:
| General Condition Example | XML | JSON |
| PHR Example | XML | JSON |
| Base Conformance Statement | XML | JSON |
General Condition Example
General Condition Example (id = "example")
<Conformance xmlns="http://hl7.org/fhir"> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p>The EHR Server supports the following transactions for the resource Person: read, vread, update, history, search(name,gender), create and updates.</p> <p>The EHR System supports the following message: admin-notify::Person.</p> <p>The EHR Application has a <a href="http://fhir.hl7.org/base/profile/@bc054d23-75e1-4dc6-aca5-838b6b1ac81d/history/@b5fdd9fc-b021-4ea1-9 11a-721a60663796">general document profile</a>.</p> </div> </text> <!-- the identifier for this conformance statement. The identifier and version establish identifiers that other specifications etc may use to refer to the conformance statement that this resource represents in a logical manner rather than in a literal (URL) fashion The identifier should be globally unique - a UUID, an OID, or a URL/URI --> <identifier value="68D043B5-9ECF-4559-A57A-396E0D452311"/> <version value="20130510"/> <publisher value="ACME Corporation"/> <telecom> <system value="email"/> <value value="wile@acme.org"/> </telecom> <date value="2012-01-04"/> <software> <name value="EHR"/> <version value="0.00.020.2134"/> </software> <!-- while the FHIR infrastructure is turning over prior to development, a version is required. Note that this may be rescinded later? --> <fhirVersion value="0.07"/> <!-- this system accepts unknown content in the resources --> <acceptUnknown value="true"/> <!-- this system can do either xml or json. (Listing both implies full support for either, with interconversion) --> <format value="xml"/> <format value="json"/> <!-- in a real conformance statement, it's unlikely that a single conformance statement would declare conformance for REST, messaging and documents, though it is legal. This example does so in order to show all the parts of a conformance statement --> <rest> <!-- this is a server conformance statement. Note that servers are required to provide one of these. It can easily be edited by hand - copy this, replace the metadata above, delete the messaging and document stuff below, and then replace the details appropriately. --> <mode value="server"/> <!-- zero or more of these - declaration of support for a resource --> <resource> <type value="Patient"/> <!-- let's assume that HL7 has stood up a profile registry at http://fhir.hl7.org/fhir - it's likely to have a registry, though this is not decided, nor is a URL decided. This application simply uses a profile registered directly with HL7. For the simplest case of a FHIR REST Server, just delete this profile reference. Profile references do not need to be a UUID, though a profile registry could insist that they are --> <profile> <type value="Profile"/> <reference value="http://fhir.hl7.org/base/profile/@7896271d-57f6-4231-89dc-dcc91eab2416"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="history-type"/> </operation> </resource> <batch value="true"/> <history value="true"/> </rest> <!-- a messaging conformance statement. Applications are not required to make a conformance statement with regard to messaging, though there is active argument that they should. --> <messaging> <!-- how to tell whether this llp is a server or a client? --> <event> <code value="admin-notify"/> <mode value="receiver"/> <!-- this a receiver - i.e. answers. Not neccessariy a serve" --> <focus value="Patient"/> <!-- specify a profile for the request person. Very often there's no point profiling the response, it's not interesting --> <request> <type value="Profile"/> <reference value="profile/@101"/> </request> <response> <type value="Profile"/> <reference value="profile/@101"/> </response> </event> </messaging> <!-- a document conformance statement --> <document> <mode value="consumer"/> <documentation value="Basic rules for all documents in the EHR system"/> <!-- this is the important element: a reference to a published document profile note that this is a version specific reference. --> <profile> <type value="Profile"/> <reference value="http://fhir.hl7.org/base/profile/@bc054d23-75e1-4dc6-aca5-838b6b1ac81d/history/@b5fdd9fc-b021-4ea1-9 11a-721a60663796"/> </profile> </document> </Conformance>
JSON Equivalent
General Condition Example
{
"Conformance":{
"text":{
"status":{
"value":"generated"
},
"div":"<div>\n <p>The EHR Server supports the following transactions for the resource Person: read, vread, \n update, history, search(name,gender), create and updates.<\/p>\n <p>The EHR System supports the following message: admin-notify::Person.<\/p>\n <p>The EHR Application has a <a href=\"http://fhir.hl7.org/base/profile/@bc054d23-75e1-4dc6-aca5-838b6b1ac81d/history/@b5fdd9fc-b021-4ea1-911a-721a60663796\">general document profile<\/a>.<\/p>\n <\/div>"
},
"identifier":{
"value":"68D043B5-9ECF-4559-A57A-396E0D452311"
},
"version":{
"value":"20130510"
},
"publisher":{
"value":"ACME Corporation"
},
"telecom":[
{
"system":{
"value":"email"
},
"value":{
"value":"wile@acme.org"
}
}
],
"date":{
"value":"2012-01-04"
},
"software":{
"name":{
"value":"EHR"
},
"version":{
"value":"0.00.020.2134"
}
},
"fhirVersion":{
"value":"0.07"
},
"acceptUnknown":{
"value":true
},
"format":[
{
"value":"xml"
},
{
"value":"json"
}
],
"rest":[
{
"mode":{
"value":"server"
},
"resource":[
{
"type":{
"value":"Patient"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://fhir.hl7.org/base/profile/@7896271d-57f6-4231-89dc-dcc91eab2416"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"history-type"
}
}
]
}
],
"batch":{
"value":true
},
"history":{
"value":true
}
}
],
"messaging":[
{
"event":[
{
"code":{
"value":"admin-notify"
},
"mode":{
"value":"receiver"
},
"focus":{
"value":"Patient"
},
"request":{
"type":{
"value":"Profile"
},
"reference":{
"value":"profile/@101"
}
},
"response":{
"type":{
"value":"Profile"
},
"reference":{
"value":"profile/@101"
}
}
}
]
}
],
"document":[
{
"mode":{
"value":"consumer"
},
"documentation":{
"value":"Basic rules for all documents in the EHR system"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://fhir.hl7.org/base/profile/@bc054d23-75e1-4dc6-aca5-838b6b1ac81d/history/@b5fdd9fc-b021-4ea1-911a-721a60663796"
}
}
}
]
}
}