{
"resourceType" : "CapabilityStatement",
"extension" : [ {
"url" : "http://ibm.com/fhir/extension/defaultTenantId",
"valueString" : "default"
}, {
"url" : "http://ibm.com/fhir/extension/websocketNotificationsEnabled",
"valueBoolean" : false
}, {
"url" : "http://ibm.com/fhir/extension/kafkaNotificationsEnabled",
"valueBoolean" : false
}, {
"url" : "http://ibm.com/fhir/extension/natsNotificationsEnabled",
"valueBoolean" : false
}, {
"url" : "http://ibm.com/fhir/extension/notificationResourceTypes",
"valueString" : "<not specified - all resource types>"
}, {
"url" : "http://ibm.com/fhir/extension/auditLogServiceName",
"valueString" : "DisabledAuditLogService"
}, {
"url" : "http://ibm.com/fhir/extension/persistenceType",
"valueString" : "FHIRPersistenceJDBCImpl"
} ],
"version" : "4.6.0",
"name" : "IBM FHIR Server",
"status" : "active",
"date" : "2021-03-19T05:16:29.054Z",
"publisher" : "IBM Corporation",
"description" : "IBM FHIR Server version 4.6.0 build id Integration_refs/tags/4.6.0_7a3c121f629adc61ff0fab6d64e91aa425a1d57c",
"copyright" : "(C) Copyright IBM Corporation 2016, 2021",
"kind" : "capability",
"instantiates" : [ "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data|1.0.1" ],
"software" : {
"id" : "Integration_refs/tags/4.6.0_7a3c121f629adc61ff0fab6d64e91aa425a1d57c",
"name" : "IBM FHIR Server",
"version" : "4.6.0"
},
"fhirVersion" : "4.0.1",
"format" : [ "json", "xml", "application/json", "application/fhir+json", "application/xml", "application/fhir+xml" ],
"patchFormat" : [ "application/json-patch+json", "application/fhir+json", "application/fhir+xml" ],
"rest" : [ {
"mode" : "server",
"security" : {
"cors" : true
},
"resource" : [ {
"type" : "Communication",
"profile" : "http://hl7.org/fhir/profiles/Communication",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Unique identifier"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Focus of message"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "received",
"type" : "date",
"documentation" : "When received"
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Part of this action"
}, {
"name" : "medium",
"type" : "token",
"documentation" : "A channel of communication"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
}, {
"name" : "sent",
"type" : "date",
"documentation" : "When sent"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Request fulfilled by this communication"
}, {
"name" : "sender",
"type" : "reference",
"documentation" : "Message sender"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Focus of message"
}, {
"name" : "recipient",
"type" : "reference",
"documentation" : "Message recipient"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Message category"
}, {
"name" : "status",
"type" : "token",
"documentation" : "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DeviceRequest",
"profile" : "http://hl7.org/fhir/profiles/DeviceRequest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "requester",
"type" : "reference",
"documentation" : "Who/what is requesting service"
}, {
"name" : "insurance",
"type" : "reference",
"documentation" : "Associated insurance coverage"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Desired performer for service"
}, {
"name" : "event-date",
"type" : "date",
"documentation" : "When service should occur"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Individual the service is ordered for"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "authored-on",
"type" : "date",
"documentation" : "When the request transitioned to being actionable"
}, {
"name" : "intent",
"type" : "token",
"documentation" : "proposal | plan | original-order |reflex-order"
}, {
"name" : "group-identifier",
"type" : "token",
"documentation" : "Composite request this is part of"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Plan/proposal/order fulfilled by this request"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "device",
"type" : "reference",
"documentation" : "Reference to resource that is being requested/ordered"
}, {
"name" : "prior-request",
"type" : "reference",
"documentation" : "Request takes the place of referenced completed or terminated requests"
}, {
"name" : "status",
"type" : "token",
"documentation" : "entered-in-error | draft | active |suspended | completed"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CoverageEligibilityResponse",
"profile" : "http://hl7.org/fhir/profiles/CoverageEligibilityResponse",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier"
}, {
"name" : "request",
"type" : "reference",
"documentation" : "The EligibilityRequest reference"
}, {
"name" : "disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
}, {
"name" : "created",
"type" : "date",
"documentation" : "The creation date"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The reference to the patient"
}, {
"name" : "insurer",
"type" : "reference",
"documentation" : "The organization which generated this resource"
}, {
"name" : "outcome",
"type" : "token",
"documentation" : "The processing outcome"
}, {
"name" : "requestor",
"type" : "reference",
"documentation" : "The EligibilityRequest provider"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The EligibilityRequest status"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductManufactured",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductManufactured",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CommunicationRequest",
"profile" : "http://hl7.org/fhir/profiles/CommunicationRequest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "authored",
"type" : "date",
"documentation" : "When request transitioned to being actionable"
}, {
"name" : "requester",
"type" : "reference",
"documentation" : "Who/what is requesting service"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Unique identifier"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Focus of message"
}, {
"name" : "replaces",
"type" : "reference",
"documentation" : "Request(s) replaced by this request"
}, {
"name" : "occurrence",
"type" : "date",
"documentation" : "When scheduled"
}, {
"name" : "medium",
"type" : "token",
"documentation" : "A channel of communication"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
}, {
"name" : "priority",
"type" : "token",
"documentation" : "routine | urgent | asap | stat"
}, {
"name" : "group-identifier",
"type" : "token",
"documentation" : "Composite request this is part of"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Fulfills plan or proposal"
}, {
"name" : "sender",
"type" : "reference",
"documentation" : "Message sender"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Focus of message"
}, {
"name" : "recipient",
"type" : "reference",
"documentation" : "Message recipient"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Message category"
}, {
"name" : "status",
"type" : "token",
"documentation" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "AdverseEvent",
"profile" : "http://hl7.org/fhir/profiles/AdverseEvent",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "When the event occurred"
}, {
"name" : "severity",
"type" : "token",
"documentation" : "mild | moderate | severe"
}, {
"name" : "study",
"type" : "reference",
"documentation" : "AdverseEvent.study"
}, {
"name" : "recorder",
"type" : "reference",
"documentation" : "Who recorded the adverse event"
}, {
"name" : "actuality",
"type" : "token",
"documentation" : "actual | potential"
}, {
"name" : "seriousness",
"type" : "token",
"documentation" : "Seriousness of the event"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Subject impacted by event"
}, {
"name" : "substance",
"type" : "reference",
"documentation" : "Refers to the specific entity that caused the adverse event"
}, {
"name" : "resultingcondition",
"type" : "reference",
"documentation" : "Effect on the subject due to this event"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "Location where adverse event occurred"
}, {
"name" : "category",
"type" : "token",
"documentation" : "product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment"
}, {
"name" : "event",
"type" : "token",
"documentation" : "Type of the event itself in relation to the subject"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Person",
"profile" : "http://hl7.org/fhir/profiles/Person",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "A person Identifier"
}, {
"name" : "birthdate",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n"
}, {
"name" : "address",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n"
}, {
"name" : "gender",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n"
}, {
"name" : "practitioner",
"type" : "reference",
"documentation" : "The Person links to this Practitioner"
}, {
"name" : "link",
"type" : "reference",
"documentation" : "Any link has this Patient, Person, RelatedPerson or Practitioner reference"
}, {
"name" : "relatedperson",
"type" : "reference",
"documentation" : "The Person links to this RelatedPerson"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n"
}, {
"name" : "phonetic",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n"
}, {
"name" : "phone",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The Person links to this Patient"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The organization at which this person record is being managed"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n"
}, {
"name" : "email",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Linkage",
"profile" : "http://hl7.org/fhir/profiles/Linkage",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "item",
"type" : "reference",
"documentation" : "Matches on any item in the Linkage"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "Author of the Linkage"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "Matches on any item in the Linkage with a type of 'source'"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DeviceUseStatement",
"profile" : "http://hl7.org/fhir/profiles/DeviceUseStatement",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Search by identifier"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Search by subject"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "device",
"type" : "reference",
"documentation" : "Search by device"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Subscription",
"profile" : "http://hl7.org/fhir/profiles/Subscription",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "payload",
"type" : "token",
"documentation" : "The mime-type of the notification payload"
}, {
"name" : "criteria",
"type" : "string",
"documentation" : "The search rules used to determine when to send a notification"
}, {
"name" : "contact",
"type" : "token",
"documentation" : "Contact details for the subscription"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The type of channel for the sent notifications"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that will receive the notifications"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current state of the subscription"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ImplementationGuide",
"profile" : "http://hl7.org/fhir/profiles/ImplementationGuide",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "resource",
"type" : "reference",
"documentation" : "Location of the resource"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "experimental",
"type" : "token",
"documentation" : "For testing purposes, not real usage"
}, {
"name" : "global",
"type" : "reference",
"documentation" : "Profile that all resources must conform to"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "Identity of the IG that this depends on"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Binary",
"profile" : "http://hl7.org/fhir/profiles/Binary",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SubstanceNucleicAcid",
"profile" : "http://hl7.org/fhir/profiles/SubstanceNucleicAcid",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Organization",
"profile" : "http://hl7.org/fhir/profiles/Organization",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Any identifier for the organization (not the accreditation issuer's identifier)"
}, {
"name" : "partof",
"type" : "reference",
"documentation" : "An organization of which this organization forms a part"
}, {
"name" : "address",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "A state specified in an address"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Is the Organization record active"
}, {
"name" : "type",
"type" : "token",
"documentation" : "A code for the type of organization"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "A country specified in an address"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the organization"
}, {
"name" : "phonetic",
"type" : "string",
"documentation" : "A portion of the organization's name using some kind of phonetic matching algorithm"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A portion of the organization's name or alias"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "A city specified in an address"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MolecularSequence",
"profile" : "http://hl7.org/fhir/profiles/MolecularSequence",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The unique identity for a particular sequence"
}, {
"name" : "referenceseqid-variant-coordinate",
"type" : "composite",
"documentation" : "Search parameter by reference sequence and variant coordinate. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as `referenceSeqId-variant-coordinate=NC_000001.11$lt345$gt123`, this means it will search for the MolecularSequence resource with variants on NC_000001.11 and with position >123 and <345, where in 1-based system resource, all strings within region NC_000001.11:124-344 will be revealed, while in 0-based system resource, all strings within region NC_000001.11:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above."
}, {
"name" : "chromosome",
"type" : "token",
"documentation" : "Chromosome number of the reference sequence"
}, {
"name" : "window-end",
"type" : "number",
"documentation" : "End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence."
}, {
"name" : "type",
"type" : "token",
"documentation" : "Amino Acid Sequence/ DNA Sequence / RNA Sequence"
}, {
"name" : "window-start",
"type" : "number",
"documentation" : "Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence."
}, {
"name" : "variant-end",
"type" : "number",
"documentation" : "End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the variant."
}, {
"name" : "chromosome-variant-coordinate",
"type" : "composite",
"documentation" : "Search parameter by chromosome and variant coordinate. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as `chromosome-variant-coordinate=1$lt345$gt123`, this means it will search for the MolecularSequence resource with variants on chromosome 1 and with position >123 and <345, where in 1-based system resource, all strings within region 1:124-344 will be revealed, while in 0-based system resource, all strings within region 1:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above."
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The subject that the observation is about"
}, {
"name" : "variant-start",
"type" : "number",
"documentation" : "Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the variant."
}, {
"name" : "chromosome-window-coordinate",
"type" : "composite",
"documentation" : "Search parameter by chromosome and window. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as `chromosome-window-coordinate=1$lt345$gt123`, this means it will search for the MolecularSequence resource with a window on chromosome 1 and with position >123 and <345, where in 1-based system resource, all strings within region 1:124-344 will be revealed, while in 0-based system resource, all strings within region 1:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above."
}, {
"name" : "referenceseqid-window-coordinate",
"type" : "composite",
"documentation" : "Search parameter by reference sequence and window. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as `referenceSeqId-window-coordinate=NC_000001.11$lt345$gt123`, this means it will search for the MolecularSequence resource with a window on NC_000001.11 and with position >123 and <345, where in 1-based system resource, all strings within region NC_000001.11:124-344 will be revealed, while in 0-based system resource, all strings within region NC_000001.11:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above."
}, {
"name" : "referenceseqid",
"type" : "token",
"documentation" : "Reference Sequence of the sequence"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Invoice",
"profile" : "http://hl7.org/fhir/profiles/Invoice",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Invoice date / posting date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business Identifier for item"
}, {
"name" : "totalgross",
"type" : "quantity",
"documentation" : "Gross total of this Invoice"
}, {
"name" : "participant-role",
"type" : "token",
"documentation" : "Type of involvement in creation of this Invoice"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Recipient(s) of goods and services"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Type of Invoice"
}, {
"name" : "issuer",
"type" : "reference",
"documentation" : "Issuing Organization of Invoice"
}, {
"name" : "participant",
"type" : "reference",
"documentation" : "Individual who was involved"
}, {
"name" : "totalnet",
"type" : "quantity",
"documentation" : "Net total of this Invoice"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Recipient(s) of goods and services"
}, {
"name" : "recipient",
"type" : "reference",
"documentation" : "Recipient of this invoice"
}, {
"name" : "account",
"type" : "reference",
"documentation" : "Account that is being balanced"
}, {
"name" : "status",
"type" : "token",
"documentation" : "draft | issued | balanced | cancelled | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ObservationDefinition",
"profile" : "http://hl7.org/fhir/profiles/ObservationDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Task",
"profile" : "http://hl7.org/fhir/profiles/Task",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "requester",
"type" : "reference",
"documentation" : "Search by task requester"
}, {
"name" : "owner",
"type" : "reference",
"documentation" : "Search by task owner"
}, {
"name" : "business-status",
"type" : "token",
"documentation" : "Search by business status"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Search for a task instance by its business identifier"
}, {
"name" : "period",
"type" : "date",
"documentation" : "Search by period Task is/was underway"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Search by task code"
}, {
"name" : "performer",
"type" : "token",
"documentation" : "Search by recommended type of performer (e.g., Requester, Performer, Scheduler)."
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Search by subject"
}, {
"name" : "focus",
"type" : "reference",
"documentation" : "Search by task focus"
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Search by task this task is part of"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Search by encounter"
}, {
"name" : "authored-on",
"type" : "date",
"documentation" : "Search by creation date"
}, {
"name" : "priority",
"type" : "token",
"documentation" : "Search by task priority"
}, {
"name" : "intent",
"type" : "token",
"documentation" : "Search by task intent"
}, {
"name" : "group-identifier",
"type" : "token",
"documentation" : "Search by group identifier"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Search by requests this task is based on"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Search by patient"
}, {
"name" : "modified",
"type" : "date",
"documentation" : "Search by last modification date"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Search by task status"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicationDispense",
"profile" : "http://hl7.org/fhir/profiles/MedicationDispense",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Returns dispenses performed by a specific individual"
}, {
"name" : "receiver",
"type" : "reference",
"documentation" : "The identity of a receiver to list dispenses for"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of a patient for whom to list dispenses"
}, {
"name" : "destination",
"type" : "reference",
"documentation" : "Returns dispenses that should be sent to a specific destination"
}, {
"name" : "responsibleparty",
"type" : "reference",
"documentation" : "Returns dispenses with the specified responsible party"
}, {
"name" : "medication",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Returns dispenses of a specific type"
}, {
"name" : "whenhandedover",
"type" : "date",
"documentation" : "Returns dispenses handed over on this date"
}, {
"name" : "whenprepared",
"type" : "date",
"documentation" : "Returns dispenses prepared on this date"
}, {
"name" : "prescription",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "context",
"type" : "reference",
"documentation" : "Returns dispenses with a specific context (episode or episode of care)"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "BodyStructure",
"profile" : "http://hl7.org/fhir/profiles/BodyStructure",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Bodystructure identifier"
}, {
"name" : "morphology",
"type" : "token",
"documentation" : "Kind of Structure"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Who this is about"
}, {
"name" : "location",
"type" : "token",
"documentation" : "Body site"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Observation",
"profile" : "http://hl7.org/fhir/profiles/Observation",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/triglyceride|4.0.1", "http://hl7.org/fhir/StructureDefinition/oxygensat|4.0.1", "http://hl7.org/fhir/StructureDefinition/bp|4.0.1", "http://hl7.org/fhir/StructureDefinition/devicemetricobservation|4.0.1", "http://hl7.org/fhir/StructureDefinition/observation-genetics|4.0.1", "http://hl7.org/fhir/StructureDefinition/heartrate|4.0.1", "http://hl7.org/fhir/StructureDefinition/ldlcholesterol|4.0.1", "http://hl7.org/fhir/StructureDefinition/resprate|4.0.1", "http://hl7.org/fhir/StructureDefinition/bodyheight|4.0.1", "http://hl7.org/fhir/StructureDefinition/bodytemp|4.0.1", "http://hl7.org/fhir/StructureDefinition/cholesterol|4.0.1", "http://hl7.org/fhir/StructureDefinition/headcircum|4.0.1", "http://hl7.org/fhir/StructureDefinition/vitalspanel|4.0.1", "http://hl7.org/fhir/StructureDefinition/bodyweight|4.0.1", "http://hl7.org/fhir/StructureDefinition/hdlcholesterol|4.0.1", "http://hl7.org/fhir/StructureDefinition/vitalsigns|4.0.1", "http://hl7.org/fhir/StructureDefinition/bmi|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "combo-data-absent-reason",
"type" : "token",
"documentation" : "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing."
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "component-data-absent-reason",
"type" : "token",
"documentation" : "The reason why the expected value in the element Observation.component.value[x] is missing."
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject that the observation is about"
}, {
"name" : "combo-code-value-quantity",
"type" : "composite",
"documentation" : "Code and quantity value parameter pair, including in components"
}, {
"name" : "value-date",
"type" : "date",
"documentation" : "The value of the observation, if the value is a date or period of time"
}, {
"name" : "value-concept",
"type" : "token",
"documentation" : "The value of the observation, if the value is a CodeableConcept"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "Related measurements the observation is made from"
}, {
"name" : "focus",
"type" : "reference",
"documentation" : "The focus of an observation when the focus is not the patient of record."
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Part of referenced event"
}, {
"name" : "has-member",
"type" : "reference",
"documentation" : "Related resource that belongs to the Observation group"
}, {
"name" : "code-value-string",
"type" : "composite",
"documentation" : "Code and string value parameter pair"
}, {
"name" : "component-code-value-quantity",
"type" : "composite",
"documentation" : "Component code and component quantity value parameter pair"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Reference to the service request."
}, {
"name" : "code-value-date",
"type" : "composite",
"documentation" : "Code and date/time value parameter pair"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "specimen",
"type" : "reference",
"documentation" : "Specimen used for this observation"
}, {
"name" : "component-code",
"type" : "token",
"documentation" : "The component code of the observation type"
}, {
"name" : "code-value-quantity",
"type" : "composite",
"documentation" : "Code and quantity value parameter pair"
}, {
"name" : "combo-code-value-concept",
"type" : "composite",
"documentation" : "Code and coded value parameter pair, including in components"
}, {
"name" : "value-string",
"type" : "string",
"documentation" : "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Who performed the observation"
}, {
"name" : "method",
"type" : "token",
"documentation" : "The method used for the observation"
}, {
"name" : "combo-code",
"type" : "token",
"documentation" : "The code of the observation type or component type"
}, {
"name" : "value-quantity",
"type" : "quantity",
"documentation" : "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
}, {
"name" : "component-value-quantity",
"type" : "quantity",
"documentation" : "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
}, {
"name" : "data-absent-reason",
"type" : "token",
"documentation" : "The reason why the expected value in the element Observation.value[x] is missing."
}, {
"name" : "combo-value-quantity",
"type" : "quantity",
"documentation" : "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "code-value-concept",
"type" : "composite",
"documentation" : "Code and coded value parameter pair"
}, {
"name" : "component-code-value-concept",
"type" : "composite",
"documentation" : "Component code and component coded value parameter pair"
}, {
"name" : "component-value-concept",
"type" : "token",
"documentation" : "The value of the component observation, if the value is a CodeableConcept"
}, {
"name" : "category",
"type" : "token",
"documentation" : "The classification of the type of observation"
}, {
"name" : "device",
"type" : "reference",
"documentation" : "The Device that generated the observation data."
}, {
"name" : "combo-value-concept",
"type" : "token",
"documentation" : "The value or component value of the observation, if the value is a CodeableConcept"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the observation"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SubstanceReferenceInformation",
"profile" : "http://hl7.org/fhir/profiles/SubstanceReferenceInformation",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "StructureMap",
"profile" : "http://hl7.org/fhir/profiles/StructureMap",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/profiles/OperationDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "instance",
"type" : "token",
"documentation" : "Invoke on an instance?"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Name used to invoke the operation"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "kind",
"type" : "token",
"documentation" : "operation | query"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Invoke at the type level?"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "input-profile",
"type" : "reference",
"documentation" : "Validation information for in parameters"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "output-profile",
"type" : "reference",
"documentation" : "Validation information for out parameters"
}, {
"name" : "system",
"type" : "token",
"documentation" : "Invoke at the system level?"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "base",
"type" : "reference",
"documentation" : "Marks this as a profile of the base"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Immunization",
"profile" : "http://hl7.org/fhir/profiles/Immunization",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "reaction",
"type" : "reference",
"documentation" : "Additional information on reaction"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "The practitioner or organization who played a role in the vaccination"
}, {
"name" : "lot-number",
"type" : "string",
"documentation" : "Vaccine Lot Number"
}, {
"name" : "status-reason",
"type" : "token",
"documentation" : "Reason why the vaccine was not administered"
}, {
"name" : "reason-code",
"type" : "token",
"documentation" : "Reason why the vaccine was administered"
}, {
"name" : "manufacturer",
"type" : "reference",
"documentation" : "Vaccine Manufacturer"
}, {
"name" : "target-disease",
"type" : "token",
"documentation" : "The target disease the dose is being administered against"
}, {
"name" : "series",
"type" : "string",
"documentation" : "The series being followed by the provider"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "vaccine-code",
"type" : "token",
"documentation" : "Vaccine Product Administered"
}, {
"name" : "reason-reference",
"type" : "reference",
"documentation" : "Why immunization occurred"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "The service delivery location or facility in which the vaccine was / was to be administered"
}, {
"name" : "reaction-date",
"type" : "date",
"documentation" : "When reaction started"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Immunization event status"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductPharmaceutical",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductPharmaceutical",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "An identifier for the pharmaceutical medicinal product"
}, {
"name" : "route",
"type" : "token",
"documentation" : "Coded expression for the route"
}, {
"name" : "target-species",
"type" : "token",
"documentation" : "Coded expression for the species"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductIngredient",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductIngredient",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DocumentReference",
"profile" : "http://hl7.org/fhir/profiles/DocumentReference",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "When this document reference was created"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Human-readable description"
}, {
"name" : "language",
"type" : "token",
"documentation" : "Human language of the content (BCP-47)"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name" : "relation",
"type" : "token",
"documentation" : "replaces | transforms | signs | appends"
}, {
"name" : "setting",
"type" : "token",
"documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
}, {
"name" : "related",
"type" : "reference",
"documentation" : "Related identifiers or resources"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "event",
"type" : "token",
"documentation" : "Main clinical acts documented"
}, {
"name" : "relationship",
"type" : "composite",
"documentation" : "Combination of relation and relatesTo"
}, {
"name" : "authenticator",
"type" : "reference",
"documentation" : "Who/what authenticated the document"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "period",
"type" : "date",
"documentation" : "Time of service that is being documented"
}, {
"name" : "custodian",
"type" : "reference",
"documentation" : "Organization which maintains the document"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "Who and/or what authored the document"
}, {
"name" : "format",
"type" : "token",
"documentation" : "Format/content rules for the document"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "contenttype",
"type" : "token",
"documentation" : "Mime type of the content, with charset etc."
}, {
"name" : "security-label",
"type" : "token",
"documentation" : "Document security-tags"
}, {
"name" : "location",
"type" : "uri",
"documentation" : "Uri where the data can be found"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Categorization of document"
}, {
"name" : "relatesto",
"type" : "reference",
"documentation" : "Target of the relationship"
}, {
"name" : "facility",
"type" : "token",
"documentation" : "Kind of facility where patient was seen"
}, {
"name" : "status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Slot",
"profile" : "http://hl7.org/fhir/profiles/Slot",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "A Slot Identifier"
}, {
"name" : "schedule",
"type" : "reference",
"documentation" : "The Schedule Resource that we are seeking a slot within"
}, {
"name" : "specialty",
"type" : "token",
"documentation" : "The specialty of a practitioner that would be required to perform the service requested in this appointment"
}, {
"name" : "service-category",
"type" : "token",
"documentation" : "A broad categorization of the service that is to be performed during this appointment"
}, {
"name" : "appointment-type",
"type" : "token",
"documentation" : "The style of appointment or patient that may be booked in the slot (not service type)"
}, {
"name" : "service-type",
"type" : "token",
"documentation" : "The type of appointments that can be booked into the slot"
}, {
"name" : "start",
"type" : "date",
"documentation" : "Appointment date/time."
}, {
"name" : "status",
"type" : "token",
"documentation" : "The free/busy status of the appointment"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CatalogEntry",
"profile" : "http://hl7.org/fhir/profiles/CatalogEntry",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SubstanceProtein",
"profile" : "http://hl7.org/fhir/profiles/SubstanceProtein",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductContraindication",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductContraindication",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "subject",
"type" : "reference",
"documentation" : "The medication for which this is an contraindication"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Specimen",
"profile" : "http://hl7.org/fhir/profiles/Specimen",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "container",
"type" : "token",
"documentation" : "The kind of specimen container"
}, {
"name" : "container-id",
"type" : "token",
"documentation" : "The unique identifier associated with the specimen container"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "The unique identifier associated with the specimen"
}, {
"name" : "parent",
"type" : "reference",
"documentation" : "The parent of the specimen"
}, {
"name" : "bodysite",
"type" : "token",
"documentation" : "The code for the body site from where the specimen originated"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject of the specimen"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The patient the specimen comes from"
}, {
"name" : "collected",
"type" : "date",
"documentation" : "The date the specimen was collected"
}, {
"name" : "accession",
"type" : "token",
"documentation" : "The accession number associated with the specimen"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The specimen type"
}, {
"name" : "collector",
"type" : "reference",
"documentation" : "Who collected the specimen"
}, {
"name" : "status",
"type" : "token",
"documentation" : "available | unavailable | unsatisfactory | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Location",
"profile" : "http://hl7.org/fhir/profiles/Location",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "An identifier for the location"
}, {
"name" : "partof",
"type" : "reference",
"documentation" : "A location of which this location is a part"
}, {
"name" : "address",
"type" : "string",
"documentation" : "A (part of the) address of the location"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "A state specified in an address"
}, {
"name" : "operational-status",
"type" : "token",
"documentation" : "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)"
}, {
"name" : "type",
"type" : "token",
"documentation" : "A code for the type of location"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "A country specified in an address"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the location"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "Searches for locations that are managed by the provided organization"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A portion of the location's name or alias"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
}, {
"name" : "near",
"type" : "special",
"documentation" : "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "A city specified in an address"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Searches for locations with a specific kind of status"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "GraphDefinition",
"profile" : "http://hl7.org/fhir/profiles/GraphDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "start",
"type" : "token",
"documentation" : "Type of resource at which the graph starts"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SupplyRequest",
"profile" : "http://hl7.org/fhir/profiles/SupplyRequest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "requester",
"type" : "reference",
"documentation" : "Individual making the request"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The destination of the supply"
}, {
"name" : "supplier",
"type" : "reference",
"documentation" : "Who is intended to fulfill the request"
}, {
"name" : "category",
"type" : "token",
"documentation" : "The kind of supply (central, non-stock, etc.)"
}, {
"name" : "status",
"type" : "token",
"documentation" : "draft | active | suspended +"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "EpisodeOfCare",
"profile" : "http://hl7.org/fhir/profiles/EpisodeOfCare",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "condition",
"type" : "reference",
"documentation" : "Conditions/problems/diagnoses this episode of care is for"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The organization that has assumed the specific responsibilities of this EpisodeOfCare"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name" : "care-manager",
"type" : "reference",
"documentation" : "Care manager/care coordinator for the patient"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the Episode of Care as provided (does not check the status history collection)"
}, {
"name" : "incoming-referral",
"type" : "reference",
"documentation" : "Incoming Referral Request"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicationKnowledge",
"profile" : "http://hl7.org/fhir/profiles/MedicationKnowledge",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "code",
"type" : "token",
"documentation" : "Code that identifies this medication"
}, {
"name" : "ingredient",
"type" : "reference",
"documentation" : "Medication(s) or substance(s) contained in the medication"
}, {
"name" : "doseform",
"type" : "token",
"documentation" : "powder | tablets | capsule +"
}, {
"name" : "classification-type",
"type" : "token",
"documentation" : "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)"
}, {
"name" : "monograph-type",
"type" : "token",
"documentation" : "The category of medication document"
}, {
"name" : "classification",
"type" : "token",
"documentation" : "Specific category assigned to the medication"
}, {
"name" : "manufacturer",
"type" : "reference",
"documentation" : "Manufacturer of the item"
}, {
"name" : "ingredient-code",
"type" : "token",
"documentation" : "Medication(s) or substance(s) contained in the medication"
}, {
"name" : "source-cost",
"type" : "token",
"documentation" : "The source or owner for the price information"
}, {
"name" : "monitoring-program-name",
"type" : "token",
"documentation" : "Name of the reviewing program"
}, {
"name" : "monograph",
"type" : "reference",
"documentation" : "Associated documentation about the medication"
}, {
"name" : "monitoring-program-type",
"type" : "token",
"documentation" : "Type of program under which the medication is monitored"
}, {
"name" : "status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProduct",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProduct",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier for this product. Could be an MPID"
}, {
"name" : "name",
"type" : "string",
"documentation" : "The full product name"
}, {
"name" : "name-language",
"type" : "token",
"documentation" : "Language code for this name"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Encounter",
"profile" : "http://hl7.org/fhir/profiles/Encounter",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "participant-type",
"type" : "token",
"documentation" : "Role of participant in encounter"
}, {
"name" : "practitioner",
"type" : "reference",
"documentation" : "Persons involved in the encounter other than the patient"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The patient or group present at the encounter"
}, {
"name" : "episode-of-care",
"type" : "reference",
"documentation" : "Episode(s) of care that this encounter should be recorded against"
}, {
"name" : "length",
"type" : "quantity",
"documentation" : "Length of encounter in days"
}, {
"name" : "diagnosis",
"type" : "reference",
"documentation" : "The diagnosis or procedure relevant to the encounter"
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Another Encounter this encounter is part of"
}, {
"name" : "appointment",
"type" : "reference",
"documentation" : "The appointment that scheduled this encounter"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name" : "reason-code",
"type" : "token",
"documentation" : "Coded reason the encounter takes place"
}, {
"name" : "participant",
"type" : "reference",
"documentation" : "Persons involved in the encounter other than the patient"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "The ServiceRequest that initiated this encounter"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "reason-reference",
"type" : "reference",
"documentation" : "Reason the encounter takes place (reference)"
}, {
"name" : "location-period",
"type" : "date",
"documentation" : "Time period during which the patient was present at the location"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "Location the encounter takes place"
}, {
"name" : "service-provider",
"type" : "reference",
"documentation" : "The organization (facility) responsible for this encounter"
}, {
"name" : "special-arrangement",
"type" : "token",
"documentation" : "Wheelchair, translator, stretcher, etc."
}, {
"name" : "class",
"type" : "token",
"documentation" : "Classification of patient encounter"
}, {
"name" : "account",
"type" : "reference",
"documentation" : "The set of accounts that may be used for billing for this Encounter"
}, {
"name" : "status",
"type" : "token",
"documentation" : "planned | arrived | triaged | in-progress | onleave | finished | cancelled +"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "EvidenceVariable",
"profile" : "http://hl7.org/fhir/profiles/EvidenceVariable",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/picoelement|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The evidence variable publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the evidence variable"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the evidence variable"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the evidence variable"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the evidence variable"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the evidence variable"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the evidence variable"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the evidence variable"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the evidence variable"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the evidence variable is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the evidence variable"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the evidence variable"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the evidence variable"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the evidence variable"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the EvidenceVariable"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the evidence variable"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the evidence variable"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Goal",
"profile" : "http://hl7.org/fhir/profiles/Goal",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "lifecycle-status",
"type" : "token",
"documentation" : "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected"
}, {
"name" : "achievement-status",
"type" : "token",
"documentation" : "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who this goal is intended for"
}, {
"name" : "start-date",
"type" : "date",
"documentation" : "When goal pursuit begins"
}, {
"name" : "category",
"type" : "token",
"documentation" : "E.g. Treatment, dietary, behavioral, etc."
}, {
"name" : "target-date",
"type" : "date",
"documentation" : "Reach goal on or before"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Questionnaire",
"profile" : "http://hl7.org/fhir/profiles/Questionnaire",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/cqf-questionnaire|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The questionnaire publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the questionnaire"
}, {
"name" : "code",
"type" : "token",
"documentation" : "A code that corresponds to one of its items in the questionnaire"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the questionnaire"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the questionnaire"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the questionnaire"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the questionnaire"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the questionnaire"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the questionnaire"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the questionnaire"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the questionnaire is intended to be in use"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the questionnaire"
}, {
"name" : "subject-type",
"type" : "token",
"documentation" : "Resource that can be subject of QuestionnaireResponse"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the questionnaire"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the questionnaire"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the questionnaire"
}, {
"name" : "definition",
"type" : "uri",
"documentation" : "ElementDefinition - details for the item"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the questionnaire"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the questionnaire"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Patient",
"profile" : "http://hl7.org/fhir/profiles/Patient",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "given",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "A patient identifier"
}, {
"name" : "birthdate",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n"
}, {
"name" : "address",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n"
}, {
"name" : "deceased",
"type" : "token",
"documentation" : "This patient has been marked as deceased, or as a death date entered"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n"
}, {
"name" : "gender",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n"
}, {
"name" : "general-practitioner",
"type" : "reference",
"documentation" : "Patient's nominated general practitioner, not the organization that manages the record"
}, {
"name" : "link",
"type" : "reference",
"documentation" : "All patients linked to the given patient"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Whether the patient record is active"
}, {
"name" : "language",
"type" : "token",
"documentation" : "Language code (irrespective of use value)"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n"
}, {
"name" : "death-date",
"type" : "date",
"documentation" : "The date of death has been provided and satisfies this search value"
}, {
"name" : "phonetic",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n"
}, {
"name" : "phone",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The organization that is the custodian of the patient record"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n"
}, {
"name" : "family",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n"
}, {
"name" : "email",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "export",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export|1.0.1",
"documentation" : "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "RelatedPerson",
"profile" : "http://hl7.org/fhir/profiles/RelatedPerson",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "An Identifier of the RelatedPerson"
}, {
"name" : "birthdate",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n"
}, {
"name" : "address",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n"
}, {
"name" : "gender",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Indicates if the related person record is active"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n"
}, {
"name" : "phonetic",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n"
}, {
"name" : "phone",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The patient this related person is related to"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n"
}, {
"name" : "relationship",
"type" : "token",
"documentation" : "The relationship between the patient and the relatedperson"
}, {
"name" : "email",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Flag",
"profile" : "http://hl7.org/fhir/profiles/Flag",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of a subject to list flags for"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "Flag creator"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "AllergyIntolerance",
"profile" : "http://hl7.org/fhir/profiles/AllergyIntolerance",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "severity",
"type" : "token",
"documentation" : "mild | moderate | severe (of event as a whole)"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "manifestation",
"type" : "token",
"documentation" : "Clinical symptoms/signs associated with the Event"
}, {
"name" : "recorder",
"type" : "reference",
"documentation" : "Who recorded the sensitivity"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "verification-status",
"type" : "token",
"documentation" : "unconfirmed | confirmed | refuted | entered-in-error"
}, {
"name" : "criticality",
"type" : "token",
"documentation" : "low | high | unable-to-assess"
}, {
"name" : "clinical-status",
"type" : "token",
"documentation" : "active | inactive | resolved"
}, {
"name" : "onset",
"type" : "date",
"documentation" : "Date(/time) when manifestations showed"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name" : "route",
"type" : "token",
"documentation" : "How the subject was exposed to the substance"
}, {
"name" : "asserter",
"type" : "reference",
"documentation" : "Source of the information about the allergy"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "category",
"type" : "token",
"documentation" : "food | medication | environment | biologic"
}, {
"name" : "last-date",
"type" : "date",
"documentation" : "Date(/time) of last known occurrence of a reaction"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ImmunizationEvaluation",
"profile" : "http://hl7.org/fhir/profiles/ImmunizationEvaluation",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Date the evaluation was generated"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "ID of the evaluation"
}, {
"name" : "target-disease",
"type" : "token",
"documentation" : "The vaccine preventable disease being evaluated against"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The patient being evaluated"
}, {
"name" : "dose-status",
"type" : "token",
"documentation" : "The status of the dose relative to published recommendations"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Immunization evaluation status"
}, {
"name" : "immunization-event",
"type" : "reference",
"documentation" : "The vaccine administration event being evaluated"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductAuthorization",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductAuthorization",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "country",
"type" : "token",
"documentation" : "The country in which the marketing authorization has been granted"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier for the marketing authorization, as assigned by a regulator"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The medicinal product that is being authorized"
}, {
"name" : "holder",
"type" : "reference",
"documentation" : "Marketing Authorization Holder"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the marketing authorization"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "BiologicallyDerivedProduct",
"profile" : "http://hl7.org/fhir/profiles/BiologicallyDerivedProduct",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "TestScript",
"profile" : "http://hl7.org/fhir/profiles/TestScript",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The test script publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the test script"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the test script"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the test script"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the test script"
}, {
"name" : "testscript-capability",
"type" : "string",
"documentation" : "TestScript required and validated capability"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the test script"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the test script"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the test script"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the test script"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the test script"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the test script"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the test script"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the test script"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the test script"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the test script"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicationAdministration",
"profile" : "http://hl7.org/fhir/profiles/MedicationAdministration",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "request",
"type" : "reference",
"documentation" : "The identity of a request to list administrations from"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "The identity of the individual who administered the medication"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of the individual or group to list administrations for"
}, {
"name" : "reason-given",
"type" : "token",
"documentation" : "Reasons for administering the medication"
}, {
"name" : "medication",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n"
}, {
"name" : "effective-time",
"type" : "date",
"documentation" : "Date administration happened (or did not happen)"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "context",
"type" : "reference",
"documentation" : "Return administrations that share this encounter or episode of care"
}, {
"name" : "reason-not-given",
"type" : "token",
"documentation" : "Reasons for not administering the medication"
}, {
"name" : "device",
"type" : "reference",
"documentation" : "Return administrations with this administration device identity"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicationRequest",
"profile" : "http://hl7.org/fhir/profiles/MedicationRequest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n"
}, {
"name" : "requester",
"type" : "reference",
"documentation" : "Returns prescriptions prescribed by this prescriber"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "intended-dispenser",
"type" : "reference",
"documentation" : "Returns prescriptions intended to be dispensed by this Organization"
}, {
"name" : "authoredon",
"type" : "date",
"documentation" : "Return prescriptions written on this date"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of a patient to list orders for"
}, {
"name" : "medication",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "priority",
"type" : "token",
"documentation" : "Returns prescriptions with different priorities"
}, {
"name" : "intent",
"type" : "token",
"documentation" : "Returns prescriptions with different intents"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "intended-performer",
"type" : "reference",
"documentation" : "Returns the intended performer of the administration of the medication request"
}, {
"name" : "intended-performertype",
"type" : "token",
"documentation" : "Returns requests for a specific type of performer"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Returns prescriptions with different categories"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CodeSystem",
"profile" : "http://hl7.org/fhir/profiles/CodeSystem",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/shareablecodesystem|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "A code defined in the code system"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "content-mode",
"type" : "token",
"documentation" : "not-present | example | fragment | complete | supplement"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "language",
"type" : "token",
"documentation" : "A language in which a designation is provided"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "supplements",
"type" : "reference",
"documentation" : "Find code system supplements for the referenced code system"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "system",
"type" : "uri",
"documentation" : "The system for any codes defined by this code system (same as 'url')"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "lookup",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup|4.0.1",
"documentation" : "Given a code/system, or a Coding, get additional details about the concept, including definition, status, designations, and properties. One of the products of this operation is a full decomposition of a code from a structured terminology.\n\nWhen invoking this operation, a client SHALL provide both a system and a code, either using the system+code parameters, or in the coding parameter. Other parameters are optional"
}, {
"name" : "subsumes",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes|4.0.1",
"documentation" : "Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see [hierarchyMeaning](codesystem-definitions.html#CodeSystem.hierarchyMeaning)).\n\nWhen invoking this operation, a client SHALL provide both a and codes, either as code or Coding parameters. The system parameter is required unless the operation is invoked on an instance of a code system resource. Other parameters are optional"
}, {
"name" : "validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code|4.0.1",
"documentation" : "Validate that a coded value is in the code system. If the operation is not called at the instance level, one of the parameters \"url\" or \"codeSystem\" must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.\n\nWhen invoking this operation, a client SHALL provide one (and only one) of the parameters (code+system, coding, or codeableConcept). Other parameters (including version and display) are optional"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ResearchDefinition",
"profile" : "http://hl7.org/fhir/profiles/ResearchDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The research definition publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the research definition"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the research definition"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the research definition"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the research definition"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the research definition"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the research definition"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the research definition"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the research definition"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the research definition is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the research definition"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the research definition"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the research definition"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the research definition"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the ResearchDefinition"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the research definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the research definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "PaymentNotice",
"profile" : "http://hl7.org/fhir/profiles/PaymentNotice",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier of the notice"
}, {
"name" : "request",
"type" : "reference",
"documentation" : "The Claim"
}, {
"name" : "provider",
"type" : "reference",
"documentation" : "The reference to the provider"
}, {
"name" : "created",
"type" : "date",
"documentation" : "Creation date fro the notice"
}, {
"name" : "response",
"type" : "reference",
"documentation" : "The ClaimResponse"
}, {
"name" : "payment-status",
"type" : "token",
"documentation" : "The type of payment notice"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the payment notice"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DeviceDefinition",
"profile" : "http://hl7.org/fhir/profiles/DeviceDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The identifier of the component"
}, {
"name" : "parent",
"type" : "reference",
"documentation" : "The parent DeviceDefinition resource"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The device component type"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductIndication",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductIndication",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "subject",
"type" : "reference",
"documentation" : "The medication for which this is an indication"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ResearchStudy",
"profile" : "http://hl7.org/fhir/profiles/ResearchStudy",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "When the study began and ended"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business Identifier for study"
}, {
"name" : "sponsor",
"type" : "reference",
"documentation" : "Organization that initiates and is legally responsible for the study"
}, {
"name" : "partof",
"type" : "reference",
"documentation" : "Part of larger study"
}, {
"name" : "focus",
"type" : "token",
"documentation" : "Drugs, devices, etc. under study"
}, {
"name" : "principalinvestigator",
"type" : "reference",
"documentation" : "Researcher who oversees multiple aspects of the study"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Name for this study"
}, {
"name" : "protocol",
"type" : "reference",
"documentation" : "Steps followed in executing study"
}, {
"name" : "site",
"type" : "reference",
"documentation" : "Facility where study activities are conducted"
}, {
"name" : "location",
"type" : "token",
"documentation" : "Geographic region(s) for study"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Classifications for the study"
}, {
"name" : "keyword",
"type" : "token",
"documentation" : "Used to search for the study"
}, {
"name" : "status",
"type" : "token",
"documentation" : "active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ConceptMap",
"profile" : "http://hl7.org/fhir/profiles/ConceptMap",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "other",
"type" : "reference",
"documentation" : "canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "target-system",
"type" : "uri",
"documentation" : "Target system that the concepts are to be mapped to"
}, {
"name" : "dependson",
"type" : "uri",
"documentation" : "Reference to property mapping depends on"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "The source value set that contains the concepts that are being mapped"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "source-uri",
"type" : "reference",
"documentation" : "The source value set that contains the concepts that are being mapped"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "target-code",
"type" : "token",
"documentation" : "Code that identifies the target element"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "source-system",
"type" : "uri",
"documentation" : "Source system where concepts to be mapped are defined"
}, {
"name" : "target-uri",
"type" : "reference",
"documentation" : "The target value set which provides context for the mappings"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name" : "product",
"type" : "uri",
"documentation" : "Reference to property mapping depends on"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "target",
"type" : "reference",
"documentation" : "The target value set which provides context for the mappings"
}, {
"name" : "source-code",
"type" : "token",
"documentation" : "Identifies element being mapped"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "closure",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-closure|4.0.1",
"documentation" : "This operation provides support for ongoing maintenance of a client-side [transitive closure table](https://en.wikipedia.org/wiki/Transitive_closure#In_graph_theory) based on server-side terminological logic. For details of how this is used, see [Maintaining a Closure Table](terminology-service.html#closure)"
}, {
"name" : "translate",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate|4.0.1",
"documentation" : "Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server. \r\n\r\n One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated. \r\n\r\n The operation returns a set of parameters including a 'result' for whether there is an acceptable match, and a list of possible matches. Note that the list of matches may include notes of codes for which mapping is specifically excluded, so implementers have to check the match.equivalence for each match"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ActivityDefinition",
"profile" : "http://hl7.org/fhir/profiles/ActivityDefinition",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/shareableactivitydefinition|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The activity definition publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the activity definition"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the activity definition"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the activity definition"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the activity definition"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the activity definition"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the activity definition"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the activity definition"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the activity definition"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the activity definition is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the activity definition"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the activity definition"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the activity definition"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the activity definition"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the activity definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the activity definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CompartmentDefinition",
"profile" : "http://hl7.org/fhir/profiles/CompartmentDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Patient | Encounter | RelatedPerson | Practitioner | Device"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "resource",
"type" : "token",
"documentation" : "Name of resource type"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ChargeItemDefinition",
"profile" : "http://hl7.org/fhir/profiles/ChargeItemDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The charge item definition publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the charge item definition"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the charge item definition"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the charge item definition"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the charge item definition"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the charge item definition"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the charge item definition"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the charge item definition"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the charge item definition"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the charge item definition is intended to be in use"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the charge item definition"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the charge item definition"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the charge item definition"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the charge item definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the charge item definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ChargeItem",
"profile" : "http://hl7.org/fhir/profiles/ChargeItem",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Business Identifier for item"
}, {
"name" : "performing-organization",
"type" : "reference",
"documentation" : "Organization providing the charged service"
}, {
"name" : "code",
"type" : "token",
"documentation" : "A code that identifies the charge, like a billing code"
}, {
"name" : "quantity",
"type" : "quantity",
"documentation" : "Quantity of which the charge item has been serviced"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Individual service was done for/to"
}, {
"name" : "occurrence",
"type" : "date",
"documentation" : "When the charged service was applied"
}, {
"name" : "entered-date",
"type" : "date",
"documentation" : "Date the charge item was entered"
}, {
"name" : "performer-function",
"type" : "token",
"documentation" : "What type of performance was done"
}, {
"name" : "factor-override",
"type" : "number",
"documentation" : "Factor overriding the associated rules"
}, {
"name" : "service",
"type" : "reference",
"documentation" : "Which rendered service is being charged?"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Individual service was done for/to"
}, {
"name" : "price-override",
"type" : "quantity",
"documentation" : "Price overriding the associated rules"
}, {
"name" : "context",
"type" : "reference",
"documentation" : "Encounter / Episode associated with event"
}, {
"name" : "enterer",
"type" : "reference",
"documentation" : "Individual who was entering"
}, {
"name" : "performer-actor",
"type" : "reference",
"documentation" : "Individual who was performing"
}, {
"name" : "account",
"type" : "reference",
"documentation" : "Account to place this charge"
}, {
"name" : "requesting-organization",
"type" : "reference",
"documentation" : "Organization requesting the charged service"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MessageDefinition",
"profile" : "http://hl7.org/fhir/profiles/MessageDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name" : "parent",
"type" : "reference",
"documentation" : "A resource that is the parent of the definition"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "focus",
"type" : "token",
"documentation" : "A resource that is a permitted focus of the message"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "event",
"type" : "token",
"documentation" : "The event that triggers the message or link to the event definition."
}, {
"name" : "category",
"type" : "token",
"documentation" : "The behavior associated with the message"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Substance",
"profile" : "http://hl7.org/fhir/profiles/Substance",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Unique identifier for the substance"
}, {
"name" : "container-identifier",
"type" : "token",
"documentation" : "Identifier of the package/container"
}, {
"name" : "code",
"type" : "token",
"documentation" : "The code of the substance or ingredient"
}, {
"name" : "quantity",
"type" : "quantity",
"documentation" : "Amount of substance in the package"
}, {
"name" : "substance-reference",
"type" : "reference",
"documentation" : "A component of the substance"
}, {
"name" : "expiry",
"type" : "date",
"documentation" : "Expiry date of package or container of substance"
}, {
"name" : "category",
"type" : "token",
"documentation" : "The category of the substance"
}, {
"name" : "status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicationStatement",
"profile" : "http://hl7.org/fhir/profiles/MedicationStatement",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "effective",
"type" : "date",
"documentation" : "Date when patient was taking (or not taking) the medication"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of a patient, animal or group to list statements for"
}, {
"name" : "context",
"type" : "reference",
"documentation" : "Returns statements for a specific context (episode or episode of Care)."
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Returns statements that are part of another event."
}, {
"name" : "medication",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "Who or where the information in the statement came from"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Returns statements of this category of medicationstatement"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ImmunizationRecommendation",
"profile" : "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Date recommendation(s) created"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier"
}, {
"name" : "target-disease",
"type" : "token",
"documentation" : "Disease to be immunized against"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Who this profile is for"
}, {
"name" : "vaccine-type",
"type" : "token",
"documentation" : "Vaccine or vaccine group recommendation applies to"
}, {
"name" : "information",
"type" : "reference",
"documentation" : "Patient observations supporting recommendation"
}, {
"name" : "support",
"type" : "reference",
"documentation" : "Past immunizations supporting recommendation"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Vaccine recommendation status"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DocumentManifest",
"profile" : "http://hl7.org/fhir/profiles/DocumentManifest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "related-id",
"type" : "token",
"documentation" : "Identifiers of things that are related"
}, {
"name" : "item",
"type" : "reference",
"documentation" : "Items in manifest"
}, {
"name" : "created",
"type" : "date",
"documentation" : "When this document manifest created"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject of the set of documents"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "Who and/or what authored the DocumentManifest"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Human-readable description (title)"
}, {
"name" : "source",
"type" : "uri",
"documentation" : "The source system/application/software"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name" : "related-ref",
"type" : "reference",
"documentation" : "Related Resource"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "recipient",
"type" : "reference",
"documentation" : "Intended to get notified about this set of documents"
}, {
"name" : "status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ClinicalImpression",
"profile" : "http://hl7.org/fhir/profiles/ClinicalImpression",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier"
}, {
"name" : "previous",
"type" : "reference",
"documentation" : "Reference to last assessment"
}, {
"name" : "finding-code",
"type" : "token",
"documentation" : "What was found"
}, {
"name" : "assessor",
"type" : "reference",
"documentation" : "The clinician performing the assessment"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Patient or group assessed"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
}, {
"name" : "finding-ref",
"type" : "reference",
"documentation" : "What was found"
}, {
"name" : "problem",
"type" : "reference",
"documentation" : "Relevant impressions of patient state"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "supporting-info",
"type" : "reference",
"documentation" : "Information supporting the clinical impression"
}, {
"name" : "investigation",
"type" : "reference",
"documentation" : "Record of a specific investigation"
}, {
"name" : "status",
"type" : "token",
"documentation" : "in-progress | completed | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SearchParameter",
"profile" : "http://hl7.org/fhir/profiles/SearchParameter",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Code used in URL"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "Original definition for the search parameter"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "type",
"type" : "token",
"documentation" : "number | date | string | token | reference | composite | quantity | uri | special"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "target",
"type" : "token",
"documentation" : "Types of resource (if a resource reference)"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "component",
"type" : "reference",
"documentation" : "Defines how the part works"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "base",
"type" : "token",
"documentation" : "The resource type(s) this search parameter applies to"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DetectedIssue",
"profile" : "http://hl7.org/fhir/profiles/DetectedIssue",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "identified",
"type" : "date",
"documentation" : "When identified"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Issue Category, e.g. drug-drug, duplicate therapy, etc."
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "The provider or device that identified the issue"
}, {
"name" : "implicated",
"type" : "reference",
"documentation" : "Problem resource"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ResearchElementDefinition",
"profile" : "http://hl7.org/fhir/profiles/ResearchElementDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The research element definition publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the research element definition"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the research element definition"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the research element definition"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the research element definition"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the research element definition"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the research element definition"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the research element definition"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the research element definition"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the research element definition is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the research element definition"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the research element definition"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the research element definition"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the research element definition"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the ResearchElementDefinition"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the research element definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the research element definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Coverage",
"profile" : "http://hl7.org/fhir/profiles/Coverage",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The primary identifier of the insured and the coverage"
}, {
"name" : "payor",
"type" : "reference",
"documentation" : "The identity of the insurer or party paying for services"
}, {
"name" : "subscriber",
"type" : "reference",
"documentation" : "Reference to the subscriber"
}, {
"name" : "beneficiary",
"type" : "reference",
"documentation" : "Covered party"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Retrieve coverages for a patient"
}, {
"name" : "class-value",
"type" : "string",
"documentation" : "Value of the class (eg. Plan number, group number)"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The kind of coverage (health plan, auto, Workers Compensation)"
}, {
"name" : "dependent",
"type" : "string",
"documentation" : "Dependent number"
}, {
"name" : "class-type",
"type" : "token",
"documentation" : "Coverage class (eg. plan, group)"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the Coverage"
}, {
"name" : "policy-holder",
"type" : "reference",
"documentation" : "Reference to the policyholder"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "EffectEvidenceSynthesis",
"profile" : "http://hl7.org/fhir/profiles/EffectEvidenceSynthesis",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The effect evidence synthesis publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the effect evidence synthesis"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the effect evidence synthesis"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the effect evidence synthesis"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the effect evidence synthesis"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the effect evidence synthesis"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the effect evidence synthesis"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the effect evidence synthesis"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the effect evidence synthesis"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the effect evidence synthesis is intended to be in use"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the effect evidence synthesis"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the effect evidence synthesis"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the effect evidence synthesis"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the effect evidence synthesis"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the effect evidence synthesis"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the effect evidence synthesis"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "EventDefinition",
"profile" : "http://hl7.org/fhir/profiles/EventDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The event definition publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the event definition"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the event definition"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the event definition"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the event definition"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the event definition"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the event definition"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the event definition"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the event definition"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the event definition is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the event definition"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the event definition"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the event definition"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the event definition"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the event definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the event definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SubstancePolymer",
"profile" : "http://hl7.org/fhir/profiles/SubstancePolymer",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductUndesirableEffect",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductUndesirableEffect",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "subject",
"type" : "reference",
"documentation" : "The medication for which this is an undesirable effect"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Device",
"profile" : "http://hl7.org/fhir/profiles/Device",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "udi-di",
"type" : "string",
"documentation" : "The udi Device Identifier (DI)"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Instance id from manufacturer, owner, and others"
}, {
"name" : "udi-carrier",
"type" : "string",
"documentation" : "UDI Barcode (RFID or other technology) string in *HRF* format."
}, {
"name" : "device-name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in Device.deviceName or Device.type."
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Patient information, if the resource is affixed to a person"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The organization responsible for the device"
}, {
"name" : "model",
"type" : "string",
"documentation" : "The model of the device"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "A location, where the resource is found"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The type of the device"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Network address to contact device"
}, {
"name" : "manufacturer",
"type" : "string",
"documentation" : "The manufacturer of the device"
}, {
"name" : "status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "AppointmentResponse",
"profile" : "http://hl7.org/fhir/profiles/AppointmentResponse",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "actor",
"type" : "reference",
"documentation" : "The Person, Location/HealthcareService or Device that this appointment response replies for"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "An Identifier in this appointment response"
}, {
"name" : "practitioner",
"type" : "reference",
"documentation" : "This Response is for this Practitioner"
}, {
"name" : "part-status",
"type" : "token",
"documentation" : "The participants acceptance status for this appointment"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "This Response is for this Patient"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "This Response is for this Location"
}, {
"name" : "appointment",
"type" : "reference",
"documentation" : "The appointment that the response is attached to"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Basic",
"profile" : "http://hl7.org/fhir/profiles/Basic",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Kind of Resource"
}, {
"name" : "created",
"type" : "date",
"documentation" : "When created"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Identifies the focus of this resource"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Identifies the focus of this resource"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "Who created"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "TerminologyCapabilities",
"profile" : "http://hl7.org/fhir/profiles/TerminologyCapabilities",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "EnrollmentRequest",
"profile" : "http://hl7.org/fhir/profiles/EnrollmentRequest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier of the Enrollment"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The party to be enrolled"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The party to be enrolled"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the enrollment"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "OperationOutcome",
"profile" : "http://hl7.org/fhir/profiles/OperationOutcome",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Condition",
"profile" : "http://hl7.org/fhir/profiles/Condition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "severity",
"type" : "token",
"documentation" : "The severity of the condition"
}, {
"name" : "evidence-detail",
"type" : "reference",
"documentation" : "Supporting information found elsewhere"
}, {
"name" : "recorded-date",
"type" : "date",
"documentation" : "Date record was first recorded"
}, {
"name" : "onset-info",
"type" : "string",
"documentation" : "Onsets as a string"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "evidence",
"type" : "token",
"documentation" : "Manifestation/symptom"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who has the condition?"
}, {
"name" : "verification-status",
"type" : "token",
"documentation" : "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error"
}, {
"name" : "clinical-status",
"type" : "token",
"documentation" : "The clinical status of the condition"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
}, {
"name" : "onset-date",
"type" : "date",
"documentation" : "Date related onsets (dateTime and Period)"
}, {
"name" : "abatement-date",
"type" : "date",
"documentation" : "Date-related abatements (dateTime and period)"
}, {
"name" : "asserter",
"type" : "reference",
"documentation" : "Person who asserts this condition"
}, {
"name" : "stage",
"type" : "token",
"documentation" : "Simple summary (disease specific)"
}, {
"name" : "abatement-string",
"type" : "string",
"documentation" : "Abatement as a string"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "abatement-age",
"type" : "quantity",
"documentation" : "Abatement as age or age range"
}, {
"name" : "onset-age",
"type" : "quantity",
"documentation" : "Onsets as age or age range"
}, {
"name" : "category",
"type" : "token",
"documentation" : "The category of the condition"
}, {
"name" : "body-site",
"type" : "token",
"documentation" : "Anatomical location, if relevant"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "GuidanceResponse",
"profile" : "http://hl7.org/fhir/profiles/GuidanceResponse",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/cdshooksguidanceresponse|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The identifier of the guidance response"
}, {
"name" : "request",
"type" : "token",
"documentation" : "The identifier of the request associated with the response"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject that the guidance response is about"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The identity of a patient to search for guidance response results"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ClaimResponse",
"profile" : "http://hl7.org/fhir/profiles/ClaimResponse",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The identity of the ClaimResponse"
}, {
"name" : "request",
"type" : "reference",
"documentation" : "The claim reference"
}, {
"name" : "disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
}, {
"name" : "created",
"type" : "date",
"documentation" : "The creation date"
}, {
"name" : "use",
"type" : "token",
"documentation" : "The type of claim"
}, {
"name" : "insurer",
"type" : "reference",
"documentation" : "The organization which generated this resource"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The subject of care"
}, {
"name" : "payment-date",
"type" : "date",
"documentation" : "The expected payment date"
}, {
"name" : "outcome",
"type" : "token",
"documentation" : "The processing outcome"
}, {
"name" : "requestor",
"type" : "reference",
"documentation" : "The Provider of the claim"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the ClaimResponse"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Provenance",
"profile" : "http://hl7.org/fhir/profiles/Provenance",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/ehrsrle-provenance|4.0.1", "http://hl7.org/fhir/StructureDefinition/provenance-relevant-history|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "agent-type",
"type" : "token",
"documentation" : "How the agent participated"
}, {
"name" : "signature-type",
"type" : "token",
"documentation" : "Indication of the reason the entity signed the object(s)"
}, {
"name" : "agent",
"type" : "reference",
"documentation" : "Who participated"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Target Reference(s) (usually version specific)"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "Where the activity occurred, if relevant"
}, {
"name" : "recorded",
"type" : "date",
"documentation" : "When the activity was recorded / updated"
}, {
"name" : "agent-role",
"type" : "token",
"documentation" : "What the agents role was"
}, {
"name" : "when",
"type" : "date",
"documentation" : "When the activity occurred"
}, {
"name" : "entity",
"type" : "reference",
"documentation" : "Identity of entity"
}, {
"name" : "target",
"type" : "reference",
"documentation" : "Target Reference(s) (usually version specific)"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CareTeam",
"profile" : "http://hl7.org/fhir/profiles/CareTeam",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who care team is for"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Type of team"
}, {
"name" : "participant",
"type" : "reference",
"documentation" : "Who is involved"
}, {
"name" : "status",
"type" : "token",
"documentation" : "proposed | active | suspended | inactive | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Consent",
"profile" : "http://hl7.org/fhir/profiles/Consent",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "period",
"type" : "date",
"documentation" : "Timeframe for this rule"
}, {
"name" : "data",
"type" : "reference",
"documentation" : "The actual data reference"
}, {
"name" : "purpose",
"type" : "token",
"documentation" : "Context of activities covered by this rule"
}, {
"name" : "source-reference",
"type" : "reference",
"documentation" : "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse"
}, {
"name" : "actor",
"type" : "reference",
"documentation" : "Resource for the actor (or group, by role)"
}, {
"name" : "security-label",
"type" : "token",
"documentation" : "Security Labels that define affected resources"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "scope",
"type" : "token",
"documentation" : "Which of the four areas this resource covers (extensible)"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "Custodian of the consent"
}, {
"name" : "action",
"type" : "token",
"documentation" : "Actions controlled by this rule"
}, {
"name" : "consentor",
"type" : "reference",
"documentation" : "Who is agreeing to the policy and rules"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Classification of the consent statement - for indexing/retrieval"
}, {
"name" : "status",
"type" : "token",
"documentation" : "draft | proposed | active | rejected | inactive | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ImagingStudy",
"profile" : "http://hl7.org/fhir/profiles/ImagingStudy",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "reason",
"type" : "token",
"documentation" : "The reason for the study"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "dicom-class",
"type" : "token",
"documentation" : "The type of the instance"
}, {
"name" : "bodysite",
"type" : "token",
"documentation" : "The body site studied"
}, {
"name" : "modality",
"type" : "token",
"documentation" : "The modality of the series"
}, {
"name" : "instance",
"type" : "token",
"documentation" : "SOP Instance UID for an instance"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "The person who performed the study"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who the study is about"
}, {
"name" : "started",
"type" : "date",
"documentation" : "When the study was started"
}, {
"name" : "interpreter",
"type" : "reference",
"documentation" : "Who interpreted the images"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "The context of the study"
}, {
"name" : "referrer",
"type" : "reference",
"documentation" : "The referring physician"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "The endpoint for the study or series"
}, {
"name" : "series",
"type" : "token",
"documentation" : "DICOM Series Instance UID for a series"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "basedon",
"type" : "reference",
"documentation" : "The order for the image"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the study"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "OrganizationAffiliation",
"profile" : "http://hl7.org/fhir/profiles/OrganizationAffiliation",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The period during which the participatingOrganization is affiliated with the primary organization"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "An organization affiliation's Identifier"
}, {
"name" : "specialty",
"type" : "token",
"documentation" : "Specific specialty of the participatingOrganization in the context of the role"
}, {
"name" : "role",
"type" : "token",
"documentation" : "Definition of the role the participatingOrganization plays"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Whether this organization affiliation record is in active use"
}, {
"name" : "primary-organization",
"type" : "reference",
"documentation" : "The organization that receives the services from the participating organization"
}, {
"name" : "network",
"type" : "reference",
"documentation" : "Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for this role"
}, {
"name" : "phone",
"type" : "token",
"documentation" : "A value in a phone contact"
}, {
"name" : "service",
"type" : "reference",
"documentation" : "Healthcare services provided through the role"
}, {
"name" : "participating-organization",
"type" : "reference",
"documentation" : "The organization that provides services to the primary organization"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "The value in any kind of contact"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "The location(s) at which the role occurs"
}, {
"name" : "email",
"type" : "token",
"documentation" : "A value in an email contact"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "TestReport",
"profile" : "http://hl7.org/fhir/profiles/TestReport",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "result",
"type" : "token",
"documentation" : "The result disposition of the test execution"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "An external identifier for the test report"
}, {
"name" : "tester",
"type" : "string",
"documentation" : "The name of the testing organization"
}, {
"name" : "testscript",
"type" : "reference",
"documentation" : "The test script executed to produce this report"
}, {
"name" : "issued",
"type" : "date",
"documentation" : "The test report generation date"
}, {
"name" : "participant",
"type" : "uri",
"documentation" : "The reference to a participant in the test execution"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SupplyDelivery",
"profile" : "http://hl7.org/fhir/profiles/SupplyDelivery",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "receiver",
"type" : "reference",
"documentation" : "Who collected the Supply"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "supplier",
"type" : "reference",
"documentation" : "Dispenser"
}, {
"name" : "status",
"type" : "token",
"documentation" : "in-progress | completed | abandoned | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Claim",
"profile" : "http://hl7.org/fhir/profiles/Claim",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "care-team",
"type" : "reference",
"documentation" : "Member of the CareTeam"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "The primary identifier of the financial resource"
}, {
"name" : "created",
"type" : "date",
"documentation" : "The creation date for the Claim"
}, {
"name" : "use",
"type" : "token",
"documentation" : "The kind of financial resource"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounters associated with a billed line item"
}, {
"name" : "priority",
"type" : "token",
"documentation" : "Processing priority requested"
}, {
"name" : "payee",
"type" : "reference",
"documentation" : "The party receiving any payment for the Claim"
}, {
"name" : "provider",
"type" : "reference",
"documentation" : "Provider responsible for the Claim"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Patient receiving the products or services"
}, {
"name" : "insurer",
"type" : "reference",
"documentation" : "The target payor/insurer for the Claim"
}, {
"name" : "detail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item, detail product or service"
}, {
"name" : "enterer",
"type" : "reference",
"documentation" : "The party responsible for the entry of the Claim"
}, {
"name" : "procedure-udi",
"type" : "reference",
"documentation" : "UDI associated with a procedure"
}, {
"name" : "subdetail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item, detail, subdetail product or service"
}, {
"name" : "item-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item product or service"
}, {
"name" : "facility",
"type" : "reference",
"documentation" : "Facility where the products or services have been or will be provided"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the Claim instance."
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Group",
"profile" : "http://hl7.org/fhir/profiles/Group",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/groupdefinition|4.0.1", "http://hl7.org/fhir/StructureDefinition/actualgroup|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "actual",
"type" : "token",
"documentation" : "Descriptive or actual"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Unique id"
}, {
"name" : "managing-entity",
"type" : "reference",
"documentation" : "Entity that is the custodian of the Group's definition"
}, {
"name" : "characteristic-value",
"type" : "composite",
"documentation" : "A composite of both characteristic and value"
}, {
"name" : "code",
"type" : "token",
"documentation" : "The kind of resources contained"
}, {
"name" : "member",
"type" : "reference",
"documentation" : "Reference to the group member"
}, {
"name" : "exclude",
"type" : "token",
"documentation" : "Group includes or excludes"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The type of resources the group contains"
}, {
"name" : "value",
"type" : "token",
"documentation" : "Value held by characteristic"
}, {
"name" : "characteristic",
"type" : "token",
"documentation" : "Kind of characteristic"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "export",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export|1.0.1",
"documentation" : "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified [Group](https://www.hl7.org/fhir/group.html). The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Bundle",
"profile" : "http://hl7.org/fhir/profiles/Bundle",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Persistent identifier for the bundle"
}, {
"name" : "composition",
"type" : "reference",
"documentation" : "The first resource in the bundle, if the bundle type is \"document\" - this is a composition, and this parameter provides access to search its contents"
}, {
"name" : "type",
"type" : "token",
"documentation" : "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection"
}, {
"name" : "message",
"type" : "reference",
"documentation" : "The first resource in the bundle, if the bundle type is \"message\" - this is a message header, and this parameter provides access to search its contents"
}, {
"name" : "timestamp",
"type" : "date",
"documentation" : "When the bundle was assembled"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ExampleScenario",
"profile" : "http://hl7.org/fhir/profiles/ExampleScenario",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The example scenario publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the example scenario"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the example scenario"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the example scenario"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the example scenario"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the example scenario"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the example scenario"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the example scenario"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the example scenario"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the example scenario"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the example scenario"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the example scenario"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the example scenario"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ResearchSubject",
"profile" : "http://hl7.org/fhir/profiles/ResearchSubject",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Start and end of participation"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Business Identifier for research subject in a study"
}, {
"name" : "study",
"type" : "reference",
"documentation" : "Study subject is part of"
}, {
"name" : "individual",
"type" : "reference",
"documentation" : "Who is part of study"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Who is part of study"
}, {
"name" : "status",
"type" : "token",
"documentation" : "candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ValueSet",
"profile" : "http://hl7.org/fhir/profiles/ValueSet",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/shareablevalueset|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "This special parameter searches for codes in the value set. See additional notes on the ValueSet resource"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "expansion",
"type" : "uri",
"documentation" : "Identifies the value set expansion (business identifier)"
}, {
"name" : "reference",
"type" : "uri",
"documentation" : "A code system included or excluded in the value set or an imported value set"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand|4.0.1",
"documentation" : "The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation. \n\nIf the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. An expanded value set will be returned, or an OperationOutcome with an error message."
}, {
"name" : "validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code|4.0.1",
"documentation" : "Validate that a coded value is in the set of codes allowed by a value set.\n\nIf the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Evidence",
"profile" : "http://hl7.org/fhir/profiles/Evidence",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/synthesis|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The evidence publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the evidence"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the evidence"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the evidence"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the evidence"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the evidence"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the evidence"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the evidence"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the evidence"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the evidence is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the evidence"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the evidence"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the evidence"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the evidence"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the Evidence"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the evidence"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the evidence"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Schedule",
"profile" : "http://hl7.org/fhir/profiles/Schedule",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Search for Schedule resources that have a period that contains this date specified"
}, {
"name" : "actor",
"type" : "reference",
"documentation" : "The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "A Schedule Identifier"
}, {
"name" : "specialty",
"type" : "token",
"documentation" : "Type of specialty needed"
}, {
"name" : "service-category",
"type" : "token",
"documentation" : "High-level category"
}, {
"name" : "service-type",
"type" : "token",
"documentation" : "The type of appointments that can be booked into associated slot(s)"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Is the schedule in active use"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Procedure",
"profile" : "http://hl7.org/fhir/profiles/Procedure",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "The reference to the practitioner"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Search by subject"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Part of referenced event"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "reason-code",
"type" : "token",
"documentation" : "Coded reason procedure performed"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "A request for this procedure"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "reason-reference",
"type" : "reference",
"documentation" : "The justification that the procedure was performed"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "Where the procedure happened"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Classification of the procedure"
}, {
"name" : "status",
"type" : "token",
"documentation" : "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SpecimenDefinition",
"profile" : "http://hl7.org/fhir/profiles/SpecimenDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "container",
"type" : "token",
"documentation" : "The type of specimen conditioned in container expected by the lab"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "The unique identifier associated with the specimen"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The type of collected specimen"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Appointment",
"profile" : "http://hl7.org/fhir/profiles/Appointment",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Appointment date/time."
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "An Identifier of the Appointment"
}, {
"name" : "specialty",
"type" : "token",
"documentation" : "The specialty of a practitioner that would be required to perform the service requested in this appointment"
}, {
"name" : "service-category",
"type" : "token",
"documentation" : "A broad categorization of the service that is to be performed during this appointment"
}, {
"name" : "practitioner",
"type" : "reference",
"documentation" : "One of the individuals of the appointment is this practitioner"
}, {
"name" : "part-status",
"type" : "token",
"documentation" : "The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests."
}, {
"name" : "appointment-type",
"type" : "token",
"documentation" : "The style of appointment or patient that has been booked in the slot (not service type)"
}, {
"name" : "service-type",
"type" : "token",
"documentation" : "The specific service that is to be performed during this appointment"
}, {
"name" : "slot",
"type" : "reference",
"documentation" : "The slots that this appointment is filling"
}, {
"name" : "reason-code",
"type" : "token",
"documentation" : "Coded reason this appointment is scheduled"
}, {
"name" : "actor",
"type" : "reference",
"documentation" : "Any one of the individuals participating in the appointment"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "The service request this appointment is allocated to assess"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "One of the individuals of the appointment is this patient"
}, {
"name" : "supporting-info",
"type" : "reference",
"documentation" : "Additional information to support the appointment"
}, {
"name" : "reason-reference",
"type" : "reference",
"documentation" : "Reason the appointment is to take place (resource)"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "This location is listed in the participants of the appointment"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The overall status of the appointment"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "QuestionnaireResponse",
"profile" : "http://hl7.org/fhir/profiles/QuestionnaireResponse",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "authored",
"type" : "date",
"documentation" : "When the questionnaire response was last changed"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "The unique identifier for the questionnaire response"
}, {
"name" : "questionnaire",
"type" : "reference",
"documentation" : "The questionnaire the answers are provided for"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Plan/proposal/order fulfilled by this questionnaire response"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "The author of the questionnaire response"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The patient that is the subject of the questionnaire response"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject of the questionnaire response"
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Procedure or observation this questionnaire response was performed as a part of"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter associated with the questionnaire response"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "The individual providing the information reflected in the questionnaire respose"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the questionnaire response"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CapabilityStatement",
"profile" : "http://hl7.org/fhir/profiles/CapabilityStatement",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "resource-profile",
"type" : "reference",
"documentation" : "A profile id invoked in a capability statement"
}, {
"name" : "software",
"type" : "string",
"documentation" : "Part of the name of a software application"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "resource",
"type" : "token",
"documentation" : "Name of a resource mentioned in a capability statement"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "format",
"type" : "token",
"documentation" : "formats supported (xml | json | ttl | mime type)"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "fhirversion",
"type" : "token",
"documentation" : "The version of FHIR"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "supported-profile",
"type" : "reference",
"documentation" : "Profiles for use cases supported"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "mode",
"type" : "token",
"documentation" : "Mode - restful (server/client) or messaging (sender/receiver)"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "security-service",
"type" : "token",
"documentation" : "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "guide",
"type" : "reference",
"documentation" : "Implementation guides supported"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MeasureReport",
"profile" : "http://hl7.org/fhir/profiles/MeasureReport",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The date of the measure report"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier of the measure report to be returned"
}, {
"name" : "period",
"type" : "date",
"documentation" : "The period of the measure report"
}, {
"name" : "measure",
"type" : "reference",
"documentation" : "The measure to return measure report results for"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of a subject to search for individual measure report results for"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The identity of a patient to search for individual measure report results for"
}, {
"name" : "reporter",
"type" : "reference",
"documentation" : "The reporter to return measure report results for"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the measure report"
}, {
"name" : "evaluated-resource",
"type" : "reference",
"documentation" : "An evaluated resource referenced by the measure report"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductPackaged",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductPackaged",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Unique identifier"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The product with this is a pack for"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "AuditEvent",
"profile" : "http://hl7.org/fhir/profiles/AuditEvent",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Time when the event was recorded"
}, {
"name" : "entity-type",
"type" : "token",
"documentation" : "Type of entity involved"
}, {
"name" : "agent",
"type" : "reference",
"documentation" : "Identifier of who"
}, {
"name" : "address",
"type" : "string",
"documentation" : "Identifier for the network access point of the user device"
}, {
"name" : "entity-role",
"type" : "token",
"documentation" : "What role the entity played"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "The identity of source detecting the event"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Type/identifier of event"
}, {
"name" : "altid",
"type" : "token",
"documentation" : "Alternative User identity"
}, {
"name" : "site",
"type" : "token",
"documentation" : "Logical source location within the enterprise"
}, {
"name" : "agent-name",
"type" : "string",
"documentation" : "Human friendly name for the agent"
}, {
"name" : "entity-name",
"type" : "string",
"documentation" : "Descriptor for entity"
}, {
"name" : "subtype",
"type" : "token",
"documentation" : "More specific type/id for the event"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Identifier of who"
}, {
"name" : "action",
"type" : "token",
"documentation" : "Type of action performed during the event"
}, {
"name" : "agent-role",
"type" : "token",
"documentation" : "Agent role in the event"
}, {
"name" : "outcome",
"type" : "token",
"documentation" : "Whether the event succeeded or failed"
}, {
"name" : "entity",
"type" : "reference",
"documentation" : "Specific instance of resource"
}, {
"name" : "policy",
"type" : "uri",
"documentation" : "Policy that authorized event"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "RiskAssessment",
"profile" : "http://hl7.org/fhir/profiles/RiskAssessment",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "condition",
"type" : "reference",
"documentation" : "Condition assessed"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Who did assessment?"
}, {
"name" : "method",
"type" : "token",
"documentation" : "Evaluation mechanism"
}, {
"name" : "probability",
"type" : "number",
"documentation" : "Likelihood of specified outcome"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who/what does assessment apply to?"
}, {
"name" : "risk",
"type" : "token",
"documentation" : "Likelihood of specified outcome as a qualitative value"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "RequestGroup",
"profile" : "http://hl7.org/fhir/profiles/RequestGroup",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/cdshooksrequestgroup|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "authored",
"type" : "date",
"documentation" : "The date the request group was authored"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifiers for the request group"
}, {
"name" : "code",
"type" : "token",
"documentation" : "The code of the request group"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject that the request group is about"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "The author of the request group"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "The FHIR-based definition from which the request group is realized"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "The encounter the request group applies to"
}, {
"name" : "priority",
"type" : "token",
"documentation" : "The priority of the request group"
}, {
"name" : "intent",
"type" : "token",
"documentation" : "The intent of the request group"
}, {
"name" : "participant",
"type" : "reference",
"documentation" : "The participant in the requests in the group"
}, {
"name" : "group-identifier",
"type" : "token",
"documentation" : "The group identifier for the request group"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The identity of a patient to search for request groups"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "The external definition from which the request group is realized"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the request group"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Endpoint",
"profile" : "http://hl7.org/fhir/profiles/Endpoint",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "payload-type",
"type" : "token",
"documentation" : "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Identifies this endpoint across multiple systems"
}, {
"name" : "connection-type",
"type" : "token",
"documentation" : "Protocol/Profile/Standard to be used with this endpoint connection"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The organization that is managing the endpoint"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A name that this endpoint can be identified by"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the Endpoint (usually expected to be active)"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "VerificationResult",
"profile" : "http://hl7.org/fhir/profiles/VerificationResult",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "target",
"type" : "reference",
"documentation" : "A resource that was validated"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "RiskEvidenceSynthesis",
"profile" : "http://hl7.org/fhir/profiles/RiskEvidenceSynthesis",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The risk evidence synthesis publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the risk evidence synthesis"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the risk evidence synthesis"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the risk evidence synthesis"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the risk evidence synthesis"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the risk evidence synthesis"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the risk evidence synthesis"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the risk evidence synthesis"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the risk evidence synthesis"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the risk evidence synthesis is intended to be in use"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the risk evidence synthesis"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the risk evidence synthesis"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the risk evidence synthesis"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the risk evidence synthesis"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the risk evidence synthesis"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the risk evidence synthesis"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "InsurancePlan",
"profile" : "http://hl7.org/fhir/profiles/InsurancePlan",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Any identifier for the organization (not the accreditation issuer's identifier)"
}, {
"name" : "address",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "A state specified in an address"
}, {
"name" : "owned-by",
"type" : "reference",
"documentation" : "An organization of which this organization forms a part"
}, {
"name" : "type",
"type" : "token",
"documentation" : "A code for the type of organization"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "A country specified in an address"
}, {
"name" : "administered-by",
"type" : "reference",
"documentation" : "Product administrator"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoint"
}, {
"name" : "phonetic",
"type" : "string",
"documentation" : "A portion of the organization's name using some kind of phonetic matching algorithm"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A portion of the organization's name or alias"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "A city specified in an address"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Is the Organization record active"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ServiceRequest",
"profile" : "http://hl7.org/fhir/profiles/ServiceRequest",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/servicerequest-genetics|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "authored",
"type" : "date",
"documentation" : "Date request signed"
}, {
"name" : "requester",
"type" : "reference",
"documentation" : "Who/what is requesting service"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Requested performer"
}, {
"name" : "requisition",
"type" : "token",
"documentation" : "Composite Request ID"
}, {
"name" : "replaces",
"type" : "reference",
"documentation" : "What request replaces"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Search by subject"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "occurrence",
"type" : "date",
"documentation" : "When service should occur"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "priority",
"type" : "token",
"documentation" : "routine | urgent | asap | stat"
}, {
"name" : "intent",
"type" : "token",
"documentation" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option"
}, {
"name" : "performer-type",
"type" : "token",
"documentation" : "Performer role"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "What request fulfills"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "specimen",
"type" : "reference",
"documentation" : "Specimen to be tested"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "body-site",
"type" : "token",
"documentation" : "Where procedure is going to be done"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Classification of service"
}, {
"name" : "status",
"type" : "token",
"documentation" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Practitioner",
"profile" : "http://hl7.org/fhir/profiles/Practitioner",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "given",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "A practitioner's Identifier"
}, {
"name" : "address",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n"
}, {
"name" : "address-state",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n"
}, {
"name" : "gender",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Whether the practitioner record is active"
}, {
"name" : "address-postalcode",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n"
}, {
"name" : "address-country",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n"
}, {
"name" : "phonetic",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n"
}, {
"name" : "phone",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
}, {
"name" : "address-use",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n"
}, {
"name" : "address-city",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n"
}, {
"name" : "family",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n"
}, {
"name" : "communication",
"type" : "token",
"documentation" : "One of the languages that the practitioner can communicate with"
}, {
"name" : "email",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "FamilyMemberHistory",
"profile" : "http://hl7.org/fhir/profiles/FamilyMemberHistory",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/familymemberhistory-genetic|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "sex",
"type" : "token",
"documentation" : "A search by a sex code of a family member"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "relationship",
"type" : "token",
"documentation" : "A search by a relationship type"
}, {
"name" : "status",
"type" : "token",
"documentation" : "partial | completed | entered-in-error | health-unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "NamingSystem",
"profile" : "http://hl7.org/fhir/profiles/NamingSystem",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "period",
"type" : "date",
"documentation" : "When is identifier valid?"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "kind",
"type" : "token",
"documentation" : "codesystem | identifier | root"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "type",
"type" : "token",
"documentation" : "e.g. driver, provider, patient, bank etc."
}, {
"name" : "id-type",
"type" : "token",
"documentation" : "oid | uuid | uri | other"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "responsible",
"type" : "string",
"documentation" : "Who maintains system namespace?"
}, {
"name" : "contact",
"type" : "string",
"documentation" : "Name of an individual to contact"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "Contact details for individual or organization"
}, {
"name" : "value",
"type" : "string",
"documentation" : "The unique identifier"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CarePlan",
"profile" : "http://hl7.org/fhir/profiles/CarePlan",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "care-team",
"type" : "reference",
"documentation" : "Who's involved in plan?"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "goal",
"type" : "reference",
"documentation" : "Desired outcome of plan"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who the care plan is for"
}, {
"name" : "replaces",
"type" : "reference",
"documentation" : "CarePlan replaced by this CarePlan"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "part-of",
"type" : "reference",
"documentation" : "Part of referenced CarePlan"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
}, {
"name" : "intent",
"type" : "token",
"documentation" : "proposal | plan | order | option"
}, {
"name" : "activity-reference",
"type" : "reference",
"documentation" : "Activity details defined in specific resource"
}, {
"name" : "condition",
"type" : "reference",
"documentation" : "Health issues this plan addresses"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Fulfills CarePlan"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "activity-date",
"type" : "date",
"documentation" : "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Type of plan"
}, {
"name" : "activity-code",
"type" : "token",
"documentation" : "Detail type of activity"
}, {
"name" : "status",
"type" : "token",
"documentation" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "PlanDefinition",
"profile" : "http://hl7.org/fhir/profiles/PlanDefinition",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/cdshooksserviceplandefinition|4.0.1", "http://hl7.org/fhir/StructureDefinition/shareableplandefinition|4.0.1", "http://hl7.org/fhir/StructureDefinition/computableplandefinition|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The plan definition publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the plan definition"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the plan definition"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the plan definition"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the plan definition"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the plan definition"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the plan definition"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The type of artifact the plan (e.g. order-set, eca-rule, protocol)"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the plan definition"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the plan definition"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the plan definition is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the plan definition"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the plan definition"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the plan definition"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the plan definition"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
}, {
"name" : "definition",
"type" : "reference",
"documentation" : "Activity or plan definitions used by plan definition"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the plan definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the plan definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "apply",
"definition" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply|4.0.0",
"documentation" : "The apply operation applies a PlanDefinition to a given context"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DiagnosticReport",
"profile" : "http://hl7.org/fhir/profiles/DiagnosticReport",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/hlaresult|4.0.1", "http://hl7.org/fhir/StructureDefinition/lipidprofile|4.0.1", "http://hl7.org/fhir/StructureDefinition/diagnosticreport-genetics|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "performer",
"type" : "reference",
"documentation" : "Who is responsible for the report"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The subject of the report"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "media",
"type" : "reference",
"documentation" : "A reference to the image source."
}, {
"name" : "conclusion",
"type" : "token",
"documentation" : "A coded conclusion (interpretation/impression) on the report"
}, {
"name" : "result",
"type" : "reference",
"documentation" : "Link to an atomic result (observation resource)"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Reference to the service request."
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "specimen",
"type" : "reference",
"documentation" : "The specimen details"
}, {
"name" : "issued",
"type" : "date",
"documentation" : "When the report was issued"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Which diagnostic discipline/department created the report"
}, {
"name" : "results-interpreter",
"type" : "reference",
"documentation" : "Who was the source of the report"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the report"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SubstanceSpecification",
"profile" : "http://hl7.org/fhir/profiles/SubstanceSpecification",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "code",
"type" : "token",
"documentation" : "The specific code"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Library",
"profile" : "http://hl7.org/fhir/profiles/Library",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/shareablelibrary|4.0.1", "http://hl7.org/fhir/StructureDefinition/cqllibrary|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The library publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the library"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the library"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the library"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the library"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the library"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the library"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the library"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the library"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the library is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the library"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the library"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the library"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the library"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
}, {
"name" : "content-type",
"type" : "token",
"documentation" : "The type of content in the library (e.g. text/cql)"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the library"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the library"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "List",
"profile" : "http://hl7.org/fhir/profiles/List",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "empty-reason",
"type" : "token",
"documentation" : "Why list is empty"
}, {
"name" : "item",
"type" : "reference",
"documentation" : "Actual entry"
}, {
"name" : "notes",
"type" : "string",
"documentation" : "The annotation - text content (as markdown)"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "If all resources have the same subject"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "Who and/or what defined the list contents (aka Author)"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Descriptive name for the list"
}, {
"name" : "status",
"type" : "token",
"documentation" : "current | retired | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MessageHeader",
"profile" : "http://hl7.org/fhir/profiles/MessageHeader",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "code",
"type" : "token",
"documentation" : "ok | transient-error | fatal-error"
}, {
"name" : "receiver",
"type" : "reference",
"documentation" : "Intended \"real-world\" recipient for the data"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "The source of the decision"
}, {
"name" : "destination",
"type" : "string",
"documentation" : "Name of system"
}, {
"name" : "focus",
"type" : "reference",
"documentation" : "The actual content of the message"
}, {
"name" : "source",
"type" : "string",
"documentation" : "Name of system"
}, {
"name" : "target",
"type" : "reference",
"documentation" : "Particular delivery destination within the destination"
}, {
"name" : "destination-uri",
"type" : "uri",
"documentation" : "Actual destination address or id"
}, {
"name" : "sender",
"type" : "reference",
"documentation" : "Real world sender of the message"
}, {
"name" : "source-uri",
"type" : "uri",
"documentation" : "Actual message source address or id"
}, {
"name" : "responsible",
"type" : "reference",
"documentation" : "Final responsibility for event"
}, {
"name" : "response-id",
"type" : "token",
"documentation" : "Id of original message"
}, {
"name" : "enterer",
"type" : "reference",
"documentation" : "The source of the data entry"
}, {
"name" : "event",
"type" : "token",
"documentation" : "Code for the event this message represents or link to event definition"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "NutritionOrder",
"profile" : "http://hl7.org/fhir/profiles/NutritionOrder",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "datetime",
"type" : "date",
"documentation" : "Return nutrition orders requested on this date"
}, {
"name" : "provider",
"type" : "reference",
"documentation" : "The identity of the provider who placed the nutrition order"
}, {
"name" : "supplement",
"type" : "token",
"documentation" : "Type of supplement product requested"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "formula",
"type" : "token",
"documentation" : "Type of enteral or infant formula"
}, {
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
}, {
"name" : "instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "oraldiet",
"type" : "token",
"documentation" : "Type of diet that can be consumed orally (i.e., take via the mouth)."
}, {
"name" : "status",
"type" : "token",
"documentation" : "Status of the nutrition order."
}, {
"name" : "additive",
"type" : "token",
"documentation" : "Type of module component to add to the feeding"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "ExplanationOfBenefit",
"profile" : "http://hl7.org/fhir/profiles/ExplanationOfBenefit",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "care-team",
"type" : "reference",
"documentation" : "Member of the CareTeam"
}, {
"name" : "coverage",
"type" : "reference",
"documentation" : "The plan under which the claim was adjudicated"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier of the Explanation of Benefit"
}, {
"name" : "created",
"type" : "date",
"documentation" : "The creation date for the EOB"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounters associated with a billed line item"
}, {
"name" : "payee",
"type" : "reference",
"documentation" : "The party receiving any payment for the Claim"
}, {
"name" : "disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
}, {
"name" : "provider",
"type" : "reference",
"documentation" : "The reference to the provider"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The reference to the patient"
}, {
"name" : "detail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item detail product or service"
}, {
"name" : "claim",
"type" : "reference",
"documentation" : "The reference to the claim"
}, {
"name" : "enterer",
"type" : "reference",
"documentation" : "The party responsible for the entry of the Claim"
}, {
"name" : "procedure-udi",
"type" : "reference",
"documentation" : "UDI associated with a procedure"
}, {
"name" : "subdetail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item detail subdetail product or service"
}, {
"name" : "facility",
"type" : "reference",
"documentation" : "Facility responsible for the goods and services"
}, {
"name" : "item-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item product or service"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Status of the instance"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Parameters",
"profile" : "http://hl7.org/fhir/profiles/Parameters",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Measure",
"profile" : "http://hl7.org/fhir/profiles/Measure",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/shareablemeasure|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The measure publication date"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the measure"
}, {
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the measure"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the measure"
}, {
"name" : "description",
"type" : "string",
"documentation" : "The description of the measure"
}, {
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the measure"
}, {
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the measure"
}, {
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "version",
"type" : "token",
"documentation" : "The business version of the measure"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the measure"
}, {
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the measure is intended to be in use"
}, {
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the measure"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the measure"
}, {
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the measure"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the measure"
}, {
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the measure"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the measure"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The current status of the measure"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Medication",
"profile" : "http://hl7.org/fhir/profiles/Medication",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "ingredient-code",
"type" : "token",
"documentation" : "Returns medications for this ingredient code"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Returns medications with this external identifier"
}, {
"name" : "code",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name" : "ingredient",
"type" : "reference",
"documentation" : "Returns medications for this ingredient reference"
}, {
"name" : "form",
"type" : "token",
"documentation" : "Returns medications for a specific dose form"
}, {
"name" : "lot-number",
"type" : "token",
"documentation" : "Returns medications in a batch with this lot number"
}, {
"name" : "expiration-date",
"type" : "date",
"documentation" : "Returns medications in a batch with this expiration date"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Returns medications for this status"
}, {
"name" : "manufacturer",
"type" : "reference",
"documentation" : "Returns medications made or sold for this manufacturer"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "DeviceMetric",
"profile" : "http://hl7.org/fhir/profiles/DeviceMetric",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The identifier of the metric"
}, {
"name" : "parent",
"type" : "reference",
"documentation" : "The parent DeviceMetric resource"
}, {
"name" : "source",
"type" : "reference",
"documentation" : "The device resource"
}, {
"name" : "type",
"type" : "token",
"documentation" : "The component type"
}, {
"name" : "category",
"type" : "token",
"documentation" : "The category of the metric"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "PaymentReconciliation",
"profile" : "http://hl7.org/fhir/profiles/PaymentReconciliation",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier of the ExplanationOfBenefit"
}, {
"name" : "request",
"type" : "reference",
"documentation" : "The reference to the claim"
}, {
"name" : "disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
}, {
"name" : "created",
"type" : "date",
"documentation" : "The creation date"
}, {
"name" : "outcome",
"type" : "token",
"documentation" : "The processing outcome"
}, {
"name" : "requestor",
"type" : "reference",
"documentation" : "The reference to the provider who submitted the claim"
}, {
"name" : "payment-issuer",
"type" : "reference",
"documentation" : "The organization which generated this resource"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the payment reconciliation"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "HealthcareService",
"profile" : "http://hl7.org/fhir/profiles/HealthcareService",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "External identifiers for this item"
}, {
"name" : "specialty",
"type" : "token",
"documentation" : "The specialty of the service provided by this healthcare service"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to electronic services operated for the healthcare service"
}, {
"name" : "service-category",
"type" : "token",
"documentation" : "Service Category of the Healthcare Service"
}, {
"name" : "coverage-area",
"type" : "reference",
"documentation" : "Location(s) service is intended for/available to"
}, {
"name" : "service-type",
"type" : "token",
"documentation" : "The type of service provided by this healthcare service"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The organization that provides this Healthcare Service"
}, {
"name" : "name",
"type" : "string",
"documentation" : "A portion of the Healthcare service name"
}, {
"name" : "active",
"type" : "token",
"documentation" : "The Healthcare Service is currently marked as active"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "The location of the Healthcare Service"
}, {
"name" : "program",
"type" : "token",
"documentation" : "One of the Programs supported by this HealthcareService"
}, {
"name" : "characteristic",
"type" : "token",
"documentation" : "One of the HealthcareService's characteristics"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Contract",
"profile" : "http://hl7.org/fhir/profiles/Contract",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The identity of the contract"
}, {
"name" : "instantiates",
"type" : "uri",
"documentation" : "A source definition of the contract"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The identity of the subject of the contract (if a patient)"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The identity of the subject of the contract"
}, {
"name" : "domain",
"type" : "reference",
"documentation" : "The domain of the contract"
}, {
"name" : "authority",
"type" : "reference",
"documentation" : "The authority of the contract"
}, {
"name" : "issued",
"type" : "date",
"documentation" : "The date/time the contract was issued"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "The basal contract definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the contract"
}, {
"name" : "signer",
"type" : "reference",
"documentation" : "Contract Signatory Party"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "VisionPrescription",
"profile" : "http://hl7.org/fhir/profiles/VisionPrescription",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "prescriber",
"type" : "reference",
"documentation" : "Who authorized the vision prescription"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "datewritten",
"type" : "date",
"documentation" : "Return prescriptions written on this date"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the vision prescription"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "SubstanceSourceMaterial",
"profile" : "http://hl7.org/fhir/profiles/SubstanceSourceMaterial",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "EnrollmentResponse",
"profile" : "http://hl7.org/fhir/profiles/EnrollmentResponse",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier of the EnrollmentResponse"
}, {
"name" : "request",
"type" : "reference",
"documentation" : "The reference to the claim"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the enrollment response"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "MedicinalProductInteraction",
"profile" : "http://hl7.org/fhir/profiles/MedicinalProductInteraction",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "subject",
"type" : "reference",
"documentation" : "The medication for which this is an interaction"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Composition",
"profile" : "http://hl7.org/fhir/profiles/Composition",
"supportedProfile" : [ "http://hl7.org/fhir/StructureDefinition/catalog|4.0.1", "http://hl7.org/fhir/StructureDefinition/clinicaldocument|4.0.1" ],
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name" : "period",
"type" : "date",
"documentation" : "The period covered by the documentation"
}, {
"name" : "related-id",
"type" : "token",
"documentation" : "Target of the relationship"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who and/or what the composition is about"
}, {
"name" : "author",
"type" : "reference",
"documentation" : "Who and/or what authored the composition"
}, {
"name" : "confidentiality",
"type" : "token",
"documentation" : "As defined by affinity domain"
}, {
"name" : "section",
"type" : "token",
"documentation" : "Classification of section (recommended)"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Human Readable name/title"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name" : "attester",
"type" : "reference",
"documentation" : "Who attested the composition"
}, {
"name" : "entry",
"type" : "reference",
"documentation" : "A reference to data that supports this section"
}, {
"name" : "related-ref",
"type" : "reference",
"documentation" : "Target of the relationship"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Code(s) that apply to the event being documented"
}, {
"name" : "category",
"type" : "token",
"documentation" : "Categorization of Composition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "preliminary | final | amended | entered-in-error"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "document",
"definition" : "http://hl7.org/fhir/OperationDefinition/Composition-document|4.0.0",
"documentation" : "A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is wrapped inside the search bundle. If some of the resources are located on other servers, it is at the discretion of the server whether to retrieve them or return an error. If the correct version of the document that would be generated already exists, then the server can return the existing one."
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "CoverageEligibilityRequest",
"profile" : "http://hl7.org/fhir/profiles/CoverageEligibilityRequest",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "The business identifier of the Eligibility"
}, {
"name" : "provider",
"type" : "reference",
"documentation" : "The reference to the provider"
}, {
"name" : "created",
"type" : "date",
"documentation" : "The creation date for the EOB"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The reference to the patient"
}, {
"name" : "enterer",
"type" : "reference",
"documentation" : "The party who is responsible for the request"
}, {
"name" : "facility",
"type" : "reference",
"documentation" : "Facility responsible for the goods and services"
}, {
"name" : "status",
"type" : "token",
"documentation" : "The status of the EligibilityRequest"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Media",
"profile" : "http://hl7.org/fhir/profiles/Media",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "identifier",
"type" : "token",
"documentation" : "Identifier(s) for the image"
}, {
"name" : "modality",
"type" : "token",
"documentation" : "The type of acquisition equipment/process"
}, {
"name" : "created",
"type" : "date",
"documentation" : "When Media was collected"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "Who/What this Media is a record of"
}, {
"name" : "encounter",
"type" : "reference",
"documentation" : "Encounter associated with media"
}, {
"name" : "type",
"type" : "token",
"documentation" : "Classification of media as image, video, or audio"
}, {
"name" : "operator",
"type" : "reference",
"documentation" : "The person who generated the image"
}, {
"name" : "site",
"type" : "token",
"documentation" : "Observed body part"
}, {
"name" : "view",
"type" : "token",
"documentation" : "Imaging view, e.g. Lateral or Antero-posterior"
}, {
"name" : "based-on",
"type" : "reference",
"documentation" : "Procedure that caused this media to be created"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "Who/What this Media is a record of"
}, {
"name" : "device",
"type" : "reference",
"documentation" : "Observing Device"
}, {
"name" : "status",
"type" : "token",
"documentation" : "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "PractitionerRole",
"profile" : "http://hl7.org/fhir/profiles/PractitionerRole",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "The period during which the practitioner is authorized to perform in these role(s)"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "A practitioner's Identifier"
}, {
"name" : "specialty",
"type" : "token",
"documentation" : "The practitioner has this specialty at an organization"
}, {
"name" : "role",
"type" : "token",
"documentation" : "The practitioner can perform this role at for the organization"
}, {
"name" : "practitioner",
"type" : "reference",
"documentation" : "Practitioner that is able to provide the defined services for the organization"
}, {
"name" : "active",
"type" : "token",
"documentation" : "Whether this practitioner role record is in active use"
}, {
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the practitioner with this role"
}, {
"name" : "phone",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n"
}, {
"name" : "service",
"type" : "reference",
"documentation" : "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
}, {
"name" : "organization",
"type" : "reference",
"documentation" : "The identity of the organization the practitioner represents / acts on behalf of"
}, {
"name" : "telecom",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n"
}, {
"name" : "location",
"type" : "reference",
"documentation" : "One of the locations at which this practitioner provides care"
}, {
"name" : "email",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "Account",
"profile" : "http://hl7.org/fhir/profiles/Account",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "owner",
"type" : "reference",
"documentation" : "Entity managing the Account"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Account number"
}, {
"name" : "period",
"type" : "date",
"documentation" : "Transaction window"
}, {
"name" : "subject",
"type" : "reference",
"documentation" : "The entity that caused the expenses"
}, {
"name" : "patient",
"type" : "reference",
"documentation" : "The entity that caused the expenses"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Human-readable label"
}, {
"name" : "type",
"type" : "token",
"documentation" : "E.g. patient, expense, depreciation"
}, {
"name" : "status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error | on-hold | unknown"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
}, {
"type" : "StructureDefinition",
"profile" : "http://hl7.org/fhir/profiles/StructureDefinition",
"interaction" : [ {
"code" : "create"
}, {
"code" : "read"
}, {
"code" : "vread"
}, {
"code" : "update"
}, {
"code" : "patch"
}, {
"code" : "delete"
}, {
"code" : "history-instance"
}, {
"code" : "search-type"
} ],
"updateCreate" : true,
"conditionalCreate" : true,
"conditionalRead" : "full-support",
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"searchParam" : [ {
"name" : "date",
"type" : "date",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name" : "context-type-value",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name" : "description",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name" : "context-type",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name" : "experimental",
"type" : "token",
"documentation" : "For testing purposes, not real usage"
}, {
"name" : "title",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name" : "type",
"type" : "uri",
"documentation" : "Type defined or constrained by this structure"
}, {
"name" : "path",
"type" : "token",
"documentation" : "A path that is constrained in the StructureDefinition"
}, {
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name" : "base-path",
"type" : "token",
"documentation" : "Path that identifies the base element"
}, {
"name" : "context",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name" : "keyword",
"type" : "token",
"documentation" : "A code for the StructureDefinition"
}, {
"name" : "context-type-quantity",
"type" : "composite",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name" : "identifier",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name" : "valueset",
"type" : "reference",
"documentation" : "A vocabulary binding reference"
}, {
"name" : "kind",
"type" : "token",
"documentation" : "primitive-type | complex-type | resource | logical"
}, {
"name" : "abstract",
"type" : "token",
"documentation" : "Whether the structure is abstract"
}, {
"name" : "version",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name" : "url",
"type" : "uri",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name" : "ext-context",
"type" : "token",
"documentation" : "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text"
}, {
"name" : "name",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name" : "publisher",
"type" : "string",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name" : "derivation",
"type" : "token",
"documentation" : "specialization | constraint - How relates to base definition"
}, {
"name" : "status",
"type" : "token",
"documentation" : "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
}, {
"name" : "base",
"type" : "reference",
"documentation" : "Definition that this type is constrained/specialized from"
}, {
"name" : "_profile",
"type" : "uri",
"documentation" : "Profiles this resource claims to conform to"
}, {
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}, {
"name" : "_tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
}, {
"name" : "_security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
}, {
"name" : "_source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
}, {
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
} ],
"operation" : [ {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-validate|4.0.0",
"documentation" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information."
} ]
} ],
"interaction" : [ {
"code" : "transaction"
} ],
"operation" : [ {
"name" : "bulkdata-status",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export-status|1.0.1",
"documentation" : "Checks the status of an asynchronous request"
}, {
"name" : "closure",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-closure|4.0.1",
"documentation" : "This operation provides support for ongoing maintenance of a client-side [transitive closure table](https://en.wikipedia.org/wiki/Transitive_closure#In_graph_theory) based on server-side terminological logic. For details of how this is used, see [Maintaining a Closure Table](terminology-service.html#closure)"
}, {
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/Resource-convert|4.0.0",
"documentation" : "This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)"
}, {
"name" : "export",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|1.0.1",
"documentation" : "Export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)"
}, {
"name" : "healthcheck",
"definition" : "http://ibm.com/fhir/OperationDefinition/healthcheck",
"documentation" : "The healthcheck operation checks whether the server is able to connect to the database."
}, {
"name" : "import",
"definition" : "http://hl7.org/fhir/OperationDefinition/BulkData-import|1.0.1",
"documentation" : "Pre ballot version of Bulk Data Import using the Parameters Object"
}, {
"name" : "reindex",
"definition" : "http://ibm.com/fhir/OperationDefinition/reindex",
"documentation" : "The reindex operation recomputes and stores search parameters."
} ]
} ]
}
Valid 4.0.1 JSON Capability Statement.