Conformance
Overview
The Conformance resource documents the functionality implemented from the HL7® FHIR® standard. Unlike most resources,
this resource is found at :serviceRootURL/metadata instead of by its resource name.
Metadata
Get the capabilities and configurations of this implementation and deployment of the FHIR standard.
GET /metadata?:parameters
Implementation Notes
- Authentication is not required to access the Conformance resource
- No parameters other than the standard
_formatparameter are supported for reading Conformance
Authorization Types
Authorization is not required.
Open Endpoint Example
Request
curl -i -H "Accept: application/json+fhir" "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata"
Status: 200 OK{
"resourceType": "Conformance",
"text": {
"status": "generated",
"div": "<div>Generated Conformance Statement</div>"
},
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata",
"name": "Cerner Conformance Statement",
"status": "draft",
"publisher": "Cerner",
"date": "2017-02-28",
"description": "Describes capabilities of this server",
"kind": "instance",
"fhirVersion": "1.0.2",
"acceptUnknown": "no",
"format": [
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"security": {
"cors": true
},
"resource": [
{
"type": "Conformance",
"interaction": [
{
"code": "read"
}
]
},
{
"type": "AllergyIntolerance",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of AllergyIntolerance ids. It is a required field if patient field is not given"
},
{
"name": "patient",
"type": "reference",
"documentation": "Who the sensitivity is for. It is a required field if _id field is not given"
},
{
"name": "status",
"type": "token",
"documentation": "Certainty of the allergy or intolerance"
}
]
},
{
"type": "Binary",
"interaction": [
{
"code": "read"
}
]
},
{
"type": "CarePlan",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Who care plan or care team is for. Either the '_id' parameter or one of the 'patient' or 'subject' parameters must be set."
},
{
"name": "subject",
"type": "reference",
"documentation": "Who care plan or care team is for. Must be a patient. Either the '_id' parameter or one of the 'patient' or 'subject' parameters must be set."
},
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of CarePlan ids. Either the '_id' parameter or one of the 'patient' or 'subject' parameters must be set."
},
{
"name": "date",
"type": "date",
"documentation": "Time period plan covers. The prefixes 'ge' and 'le' are supported for this parameter. Date may be provided once to imply a date range or twice to specify a range. When two dates are provided they must create a closed range."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to return in a page."
},
{
"name": "category",
"type": "token",
"documentation": "Determines if searching for care plan or care team, and if a care team then which type."
},
{
"name": "context",
"type": "reference",
"documentation": "The encounter for which this care team was responsible."
}
]
},
{
"type": "Condition",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Condition ids. It is a required field if patient field is not given"
},
{
"name": "patient",
"type": "reference",
"documentation": "The patient who has the condition. It is a required field if _id field is not given"
},
{
"name": "clinicalstatus",
"type": "token",
"documentation": "A list of desired clinical statuses of the condition"
},
{
"name": "category",
"type": "token",
"documentation": "The category of the condition"
}
]
},
{
"type": "Device",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient who has the device affixed. It is a required field if _id field is not given"
},
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Device ids. It is a required field if patient field is not given"
}
]
},
{
"type": "DiagnosticReport",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The subject of the report if a patient. It is a required field if subject field is not given"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the report. It is a required field if patient field is not given"
},
{
"name": "date",
"type": "date",
"documentation": "The start date after which or date range in which the report occurs. If only start date is provided, must be prefixed by 'ge'. If range is provided, this parameter value should be present twice, prefixed once by 'ge' representing the earliest date and once by 'lt' representing the latest date"
}
]
},
{
"type": "DocumentReference",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient the document is about"
},
{
"name": "type",
"type": "token",
"documentation": "The type of the document"
}
]
},
{
"type": "Encounter",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient present at the encounter. It is a required field if _id field is not given"
},
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Encounter ids. It is a required field if patient field is not given"
}
]
},
{
"type": "Goal",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list goals for. It is a required field if _id or subject field are not given."
},
{
"name": "targetdate",
"type": "date",
"documentation": "A date or date range from which to find Goals. The 'targetDate' parameter may be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. Alternately it may be provided twice with 'le, 'lt', 'ge', or 'gt' prefixes to search for goals within specific range. The date and prefix pairs must create a closed range."
},
{
"name": "_id",
"type": "token",
"documentation": "One or more Goal ids separated by commas. It is a required field if patient or subject field are not given."
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject for whom the goal is established. Must be a Patient. It is a required field if patient or id fields are not provided."
}
]
},
{
"type": "Immunization",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient for the vaccination record. It is a required field if _id is not given"
},
{
"name": "date",
"type": "date",
"documentation": "The date range into which the immunization falls. It is an optional field. This parameter value should be prefixed once by 'ge' representing the earliest date, and once by 'le' representing the latest date"
},
{
"name": "_id",
"type": "token",
"documentation": "One or more Immunization ids separated by commas. It is a required field if patient field is not given"
}
]
},
{
"type": "MedicationOrder",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list medication orders for. It is a required field"
},
{
"name": "status",
"type": "token",
"documentation": "One or more medication order status values separated by commas."
},
{
"name": "-timing-boundsPeriod",
"type": "date",
"documentation": "The date-time which should fall within the period the medication should be given to the patient. Must be prefixed by 'ge'."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to include in a page."
}
]
},
{
"type": "MedicationStatement",
"interaction": [
{
"code": "search-type"
},
{
"code": "read"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list statements for. It is a required field."
},
{
"name": "status",
"type": "token",
"documentation": "One or more medication statement status values separated by commas."
},
{
"name": "effectivedate",
"type": "date",
"documentation": "The date-time which should fall within the period the patient was taking (or not taking) the medication. Must be prefixed by 'ge'."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to include in a page."
},
{
"name": "_id",
"type": "token",
"documentation": "One or more Medication Statement ids separated by commas. It is a required field if patient field is not given"
}
]
},
{
"type": "Observation",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The subject that the observation is about (if patient). It is a required field if the subject field is not given"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the observation is about. It is a required field if the patient field is not given"
},
{
"name": "code",
"type": "token",
"documentation": "One or more observation types separated by commas."
},
{
"name": "date",
"type": "date",
"documentation": "The date range into which the observation falls. This parameter value should be present twice, prefixed once by 'gt' representing the earliest date and once by 'lt' representing the latest date"
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to return in a page."
}
]
},
{
"type": "OperationDefinition",
"interaction": [
{
"code": "read"
}
]
},
{
"type": "Patient",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Patient ids. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "name",
"type": "string",
"documentation": "A portion of either family or given name of the patient. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "telecom",
"type": "token",
"documentation": "The value in any kind of telecom details of the patient. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to return. Not honoured when '_id' or 'identifier' are set."
}
]
},
{
"type": "Person",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Person ids. It is a required field if no identifier is given."
},
{
"name": "identifier",
"type": "token",
"documentation": "A person identifier. It is a required field if no _id field is given"
}
]
}
],
"operation": [
{
"name": "autogen-ccd-if",
"definition": {
"reference": "https://fhir-ehr.cerner.com/dstu2/OperationDefinition/binary-autogen-ccd-if",
"display": "Generate Continuity of Care Document (CCD)"
}
},
{
"name": "docref",
"definition": {
"reference": "http://fhir.org/guides/argonaut/OperationDefinition/docref",
"display": "Argonaut Get DocumentReferences"
}
}
]
}
]
} Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Closed Endpoint Example
Request
curl -i -H "Accept: application/json+fhir" "https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata"
Status: 200 OK{
"resourceType": "Conformance",
"text": {
"status": "generated",
"div": "<div>Generated Conformance Statement</div>"
},
"url": "https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata",
"name": "Cerner Conformance Statement",
"status": "draft",
"publisher": "Cerner",
"date": "2017-02-28",
"description": "Describes capabilities of this server",
"kind": "instance",
"fhirVersion": "1.0.2",
"acceptUnknown": "no",
"format": [
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"security": {
"extension": [
{
"url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
"extension": [
{
"url": "token",
"valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/token"
},
{
"url": "authorize",
"valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/personas/provider/authorize"
}
]
}
],
"cors": true,
"service": [
{
"coding": [
{
"system": "http://hl7.org/fhir/restful-security-service",
"code": "SMART-on-FHIR"
}
],
"text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org/)."
}
],
"description": "OAuth2 plus SMART extensions"
},
"resource": [
{
"type": "Conformance",
"interaction": [
{
"code": "read"
}
]
},
{
"type": "AllergyIntolerance",
"interaction": [
{
"code": "create"
},
{
"code": "read"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"updateCreate": false,
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of AllergyIntolerance ids. It is a required field if patient field is not given"
},
{
"name": "patient",
"type": "reference",
"documentation": "Who the sensitivity is for. It is a required field if _id field is not given"
},
{
"name": "status",
"type": "token",
"documentation": "Certainty of the allergy or intolerance"
}
]
},
{
"type": "Binary",
"interaction": [
{
"code": "read"
}
]
},
{
"type": "CarePlan",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Who care plan or care team is for. Either the '_id' parameter or one of the 'patient' or 'subject' parameters must be set."
},
{
"name": "subject",
"type": "reference",
"documentation": "Who care plan or care team is for. Must be a patient. Either the '_id' parameter or one of the 'patient' or 'subject' parameters must be set."
},
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of CarePlan ids. Either the '_id' parameter or one of the 'patient' or 'subject' parameters must be set."
},
{
"name": "date",
"type": "date",
"documentation": "Time period plan covers. The prefixes 'ge' and 'le' are supported for this parameter. Date may be provided once to imply a date range or twice to specify a range. When two dates are provided they must create a closed range."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to return in a page."
},
{
"name": "category",
"type": "token",
"documentation": "Determines if searching for care plan or care team, and if a care team then which type."
},
{
"name": "context",
"type": "reference",
"documentation": "The encounter for which this care team was responsible."
}
]
},
{
"type": "Condition",
"interaction": [
{
"code": "create"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "update"
}
],
"updateCreate": false,
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Condition ids. It is a required field if patient field is not given"
},
{
"name": "patient",
"type": "reference",
"documentation": "The patient who has the condition. It is a required field if _id field is not given"
},
{
"name": "clinicalstatus",
"type": "token",
"documentation": "A list of desired clinical statuses of the condition"
},
{
"name": "category",
"type": "token",
"documentation": "The category of the condition"
}
]
},
{
"type": "Device",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient who has the device affixed. It is a required field if _id field is not given"
},
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Device ids. It is a required field if patient field is not given"
}
]
},
{
"type": "DiagnosticReport",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The subject of the report if a patient. It is a required field if subject field is not given"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the report. It is a required field if patient field is not given"
},
{
"name": "date",
"type": "date",
"documentation": "The start date after which or date range in which the report occurs. If only start date is provided, must be prefixed by 'ge'. If range is provided, this parameter value should be present twice, prefixed once by 'ge' representing the earliest date and once by 'lt' representing the latest date"
}
]
},
{
"type": "DocumentReference",
"interaction": [
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient the document is about"
},
{
"name": "type",
"type": "token",
"documentation": "The type of the document"
}
]
},
{
"type": "Encounter",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient present at the encounter. It is a required field if _id field is not given"
},
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Encounter ids. It is a required field if patient field is not given"
}
]
},
{
"type": "Goal",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list goals for. It is a required field if _id or subject field are not given."
},
{
"name": "targetdate",
"type": "date",
"documentation": "A date or date range from which to find Goals. The 'targetDate' parameter may be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for goals within specific range. The date and prefix pairs must create a closed range."
},
{
"name": "_id",
"type": "token",
"documentation": "One or more Goal ids separated by commas. It is a required field if patient or subject field are not given."
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject for whom the goal is established. Must be a Patient. It is a required field if patient or id fields are not provided."
}
]
},
{
"type": "Immunization",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient for the vaccination record. It is a required field if _id is not given"
},
{
"name": "date",
"type": "date",
"documentation": "The date range into which the immunization falls. It is an optional field. This parameter value should be prefixed once by 'ge' representing the earliest date, and once by 'le' representing the latest date"
},
{
"name": "_id",
"type": "token",
"documentation": "One or more Immunization ids separated by commas. It is a required field if patient field is not given"
}
]
},
{
"type": "MedicationOrder",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list medication orders for. It is a required field"
},
{
"name": "status",
"type": "token",
"documentation": "One or more medication order status values separated by commas."
},
{
"name": "-timing-boundsPeriod",
"type": "date",
"documentation": "The date-time which should fall within the period the medication should be given to the patient. Must be prefixed by 'ge'."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to include in a page."
}
]
},
{
"type": "MedicationStatement",
"interaction": [
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
}
],
"updateCreate": false,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list statements for. It is a required field."
},
{
"name": "status",
"type": "token",
"documentation": "One or more medication statement status values separated by commas."
},
{
"name": "effectivedate",
"type": "date",
"documentation": "The date-time which should fall within the period the patient was taking (or not taking) the medication. Must be prefixed by 'ge'."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to include in a page."
},
{
"name": "_id",
"type": "token",
"documentation": "One or more Medication Statement ids separated by commas. It is a required field if patient field is not given"
}
]
},
{
"type": "Observation",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The subject that the observation is about (if patient). It is a required field if the subject field is not given"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the observation is about. It is a required field if the patient field is not given"
},
{
"name": "code",
"type": "token",
"documentation": "One or more observation types separated by commas."
},
{
"name": "date",
"type": "date",
"documentation": "The date range into which the observation falls. This parameter value should be present twice, prefixed once by 'gt' representing the earliest date and once by 'lt' representing the latest date"
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to return in a page."
}
]
},
{
"type": "OperationDefinition",
"interaction": [
{
"code": "read"
}
]
},
{
"type": "Patient",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Patient ids. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "name",
"type": "string",
"documentation": "A portion of either family or given name of the patient. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "telecom",
"type": "token",
"documentation": "The value in any kind of telecom details of the patient. Either the '_id' parameter or 'identifier' parameter or any of combination of 'name', 'birthdate' and 'telecom' parameters must be set."
},
{
"name": "_count",
"type": "number",
"documentation": "The maximum number of results to return. Not honoured when '_id' or 'identifier' are set."
}
]
},
{
"type": "Person",
"interaction": [
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "A single or comma separated list of Person ids. It is a required field if no identifier is given."
},
{
"name": "identifier",
"type": "token",
"documentation": "A person identifier. It is a required field if no _id field is given"
}
]
}
],
"operation": [
{
"name": "autogen-ccd-if",
"definition": {
"reference": "https://fhir-ehr.cerner.com/dstu2/OperationDefinition/binary-autogen-ccd-if",
"display": "Generate Continuity of Care Document (CCD)"
}
},
{
"name": "docref",
"definition": {
"reference": "http://fhir.org/guides/argonaut/OperationDefinition/docref",
"display": "Argonaut Get DocumentReferences"
}
}
]
}
]
} Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.