{
"description": "Basic conformance statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount",
"_filename": "conformance-terminology-server.json",
"package_name": "hl7.fhir.core",
"format": [ "json", "xml" ],
"_format": [ {
"fhir_comments": [ " json is mandatory, for support of mobile clients " ]
}, {
"fhir_comments": [ " xml is optional, but strongly recommended " ]
} ],
"date": "2015-07-05",
"publisher": "HL7, Inc",
"fhirVersion": "1.4.0",
"name": "Terminology Service Conformance Statement",
"acceptUnknown": "both",
"type": null,
"experimental": null,
"resourceType": "Conformance",
"title": null,
"package_version": "1.4.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/conformance-supported-system",
"valueUri": "http://loinc.org",
"fhir_comments": [ " \n in addition to the code systems defined in line in value sets, \n\t terminology servers also provide terminology functionality on \n\t\tadditional code systems. Typically, LOINC, SNOMED CT, RcNorm in USA, etc.). \n\t\t\n\t\tThese extra code systems are declared here in this extension. It's a todo \n\t\tfor a future version to standardise things like which versions are supported etc. \n\t " ]
} ],
"status": "draft",
"id": "aae6ce85-02ae-4e3d-aa36-982713717997",
"kind": "capability",
"url": "http://hl7.org/fhir/terminology-server",
"software": {
"name": "ACME Terminology Server"
},
"version": null,
"contact": [ {
"name": "FHIR Project",
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "other"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "ValueSet",
"profile": {
"reference": "StructureDefinition/ValueSet"
},
"interaction": [ {
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the value sets"
}, {
"code": "search-type",
"documentation": "Search allows clients to find value sets on the server"
} ],
"searchParam": [ {
"name": "code",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-code",
"fhir_comments": [ " \n servers should also consider offering these interactions to allow clients \n to edit the content on the server, but are not required to do so\n \n\t\t\n\t \n \n\t\t\n\t \n \n\t\t\n\t \n \n this bit is up to servers - if they support editing, they should do so version safely\n \n ", " no need for version history (though servers can), and no need to conditional updates etc. ", " search parameters: at least code, date, name, reference, status, system, url and version. More is recommended " ]
}, {
"name": "date",
"type": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-date"
}, {
"name": "name",
"type": "string",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-name"
}, {
"name": "reference",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-reference"
}, {
"name": "status",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-status"
}, {
"name": "system",
"type": "uri",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-system"
}, {
"name": "url",
"type": "uri",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-url"
}, {
"name": "version",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-version"
} ],
"fhir_comments": [ " Server could implement value set & concept map editing using \n SMART-on-FHIR, but this doesn't make sense for the actual terminology services API\n \n \n \n \n \n \n ", " value set. Must provide read and search " ]
}, {
"type": "ConceptMap",
"profile": {
"reference": "StructureDefinition/ConceptMap"
},
"interaction": [ {
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the concept maps"
}, {
"code": "search-type",
"documentation": "Search allows clients to find concept maps on the server"
} ],
"searchParam": [ {
"name": "date",
"type": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-date",
"fhir_comments": [ " \n servers should also consider offering these interactions to allow clients \n to edit the content on the server, but are not required to do so\n \n\t\t\n\t \n \n\t\t\n\t \n \n\t\t\n\t \n \n this bit is up to servers - if they support editing, they should do so version safely\n \n ", " no need for version history (though servers can), and no need to conditional updates etc. ", " search parameters: at least date, name, status, source, target, url, version. More is recommended " ]
}, {
"name": "name",
"type": "string",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-name"
}, {
"name": "status",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-status"
}, {
"name": "source",
"type": "uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source"
}, {
"name": "target",
"type": "uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target"
}, {
"name": "url",
"type": "uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-url"
}, {
"name": "version",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-version"
} ]
} ],
"security": {
"cors": true,
"_cors": {
"fhir_comments": [ " yes - terminology servers are expected to be used from web applications, and need to implement CORS " ]
},
"service": [ {
"coding": [ {
"code": "Certificates",
"system": "http://hl7.org/fhir/restful-security-service"
} ],
"fhir_comments": [ " this bit is optional: security using registered client certificates " ]
} ]
},
"operation": [ {
"name": "expand",
"definition": {
"reference": "OperationDefinition/ValueSet-expand"
},
"fhir_comments": [ " now, operations. We expect terminology services to implement these \n named services, though not necessarily actually these profiles " ]
}, {
"name": "lookup",
"definition": {
"reference": "OperationDefinition/CodeSystem-lookup"
}
}, {
"name": "validate-code",
"definition": {
"reference": "OperationDefinition/ValueSet-validate-code"
}
}, {
"name": "translate",
"definition": {
"reference": "OperationDefinition/ConceptMap-translate"
}
}, {
"name": "closure",
"definition": {
"reference": "OperationDefinition/ConceptMap-closure"
}
} ],
"documentation": "RESTful Terminology Server",
"fhir_comments": [ " profile - terminology servers may consider \n supporting the shareable value set directly, but\n are not required. HL7 servers will\n \n \n \n " ]
} ],
"_acceptUnknown": {
"fhir_comments": [ " this can be either, but accepting unknown elements is \n preferred for forwards compatibility (Not that it matters during the DSTU period) " ]
}
}