Snapshot 3: Connectathon 32 Base

This is Snapshot #3 for FHIR R5, released to support Connectathon 32. For a full list of available versions, see the Directory of published versions.

Example CapabilityStatement/phr (Turtle)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw Turtle (+ also see Turtle/RDF Format Specification)

PHR Example

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "phr"]; # 
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n     \n      <p>Prototype Capability Statement for September 2013 Connectathon</p>\n     \n      <p>The server offers read and search support on the following resource types:</p>\n     \n      <ul>\n      \n        <li>Patient</li>\n      \n        <li>DocumentReference</li>\n      \n        <li>Condition</li>\n      \n        <li>DiagnosticReport</li>\n    \n      </ul>\n    \n    </div>"
  ]; # 
  fhir:CapabilityStatement.name [ fhir:value "PHR Template"]; # 
  fhir:CapabilityStatement.status [ fhir:value "draft"]; # 
  fhir:CapabilityStatement.date [ fhir:value "2013-06-18"^^xsd:date]; # 
  fhir:CapabilityStatement.publisher [ fhir:value "FHIR Project"]; # 
  fhir:CapabilityStatement.contact [
     fhir:index 0;
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ]; # 
  fhir:CapabilityStatement.description [ fhir:value "Prototype Capability Statement for September 2013 Connectathon"]; # 
  fhir:CapabilityStatement.kind [ fhir:value "capability"]; # 
  fhir:CapabilityStatement.software [
     fhir:CapabilityStatement.software.name [ fhir:value "ACME PHR Server" ]
  ]; # 
  fhir:CapabilityStatement.fhirVersion [ fhir:value "5.0.0"]; #    while the FHIR infrastructure is turning over prior to development, a version is required. Note that this may be rescinded later   
  fhir:CapabilityStatement.format [
     fhir:value "json";
     fhir:index 0
  ], [
     fhir:value "xml";
     fhir:index 1
  ]; #   
    for the connectathon, servers should support both xml and json. Clients can use only one. 
    
  fhir:CapabilityStatement.rest [
     fhir:index 0;
     fhir:CapabilityStatement.rest.mode [ fhir:value "server" ];
     fhir:CapabilityStatement.rest.documentation [ fhir:value "Protoype server Capability Statement for September 2013 Connectathon" ];
     fhir:CapabilityStatement.rest.security [
       fhir:CapabilityStatement.rest.security.service [
         fhir:index 0;
         fhir:CodeableConcept.text [ fhir:value "OAuth" ]
       ];
       fhir:CapabilityStatement.rest.security.description [ fhir:value "We recommend that PHR servers use standard OAuth using a          standard 3rd party provider. We are not testing the ability to provide an          OAuth authentication/authorization service itself, and nor is providing          any security required for the connectathon at all" ]
     ];
     fhir:CapabilityStatement.rest.resource [
       fhir:index 0;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Patient" ]; #    patient resource: read and search for patients the authenticated user has access too   
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ];
         fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "When a client searches patients with no search criteria, they get a list of all patients they have access too. Servers may elect to offer additional search parameters, but this is not required" ]
       ]
     ], [
       fhir:index 1;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "DocumentReference" ]; #    document reference resource: read and search    
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "_id" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "_id parameter always supported. For the connectathon, servers may elect which search parameters are supported" ]
       ]
     ], [
       fhir:index 2;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Condition" ]; #    Condition - let the patient see a list of their Conditions   
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "_id" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Standard _id parameter" ]
       ]
     ], [
       fhir:index 3;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "DiagnosticReport" ]; #    Diagnostic Reports - can be lots of these, so we'll suggest that at least service category should be supported as a search criteria   
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "_id" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Standard _id parameter" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "service" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "which diagnostic discipline/department created the report" ]
       ]
     ]
  ]] . # 

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------


Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.